Package com.softlayer.api.service.software

Interface VirtualLicense.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

VirtualLicense

@ApiService("SoftLayer_Software_VirtualLicense")
public static interface VirtualLicense.Service
extends Service

SoftLayer_Software_VirtualLicense is the application class that handles a special type of Software License. Most software licenses are licensed to a specific hardware ID; virtual licenses are designed for virtual machines and therefore are assigned to an IP Address. Not all software packages can be "virtual licensed".

SoftLayer_Software_VirtualLicense's service allows you to retrieve the hard-copy license file for a virtual license, if one exists for your license instance.

You can also retrieve the subnet that the IP to which a software virtual license is licensed upon exists in, as well as the software description that this virtual license is for.

See Also:

SoftLayer_Software_VirtualLicense

Method Summary

Modifier and Type	Method	Description
VirtualLicense.ServiceAsync	asAsync()	Get an async version of this service
Account	getAccount()	The customer account this Virtual License belongs to.
Item	getBillingItem()	The billing item for a software virtual license.
Server	getHostHardware()	The hardware record to which the software virtual license is assigned.
IpAddress	getIpAddressRecord()	The IP Address record associated with a virtual license.
byte[]	getLicenseFile()	Attempt to retrieve the file associated with a virtual license, if such a file exists.
VirtualLicense	getObject()	getObject retrieves the SoftLayer_Software_VirtualLicense object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Software_VirtualLicense service.
Description	getSoftwareDescription()	The SoftLayer_Software_Description that this virtual license is for.
Subnet	getSubnet()	The subnet this Virtual License's IP address belongs to.
void	setMask(VirtualLicense.Mask mask)
VirtualLicense.Mask	withMask()	Use the existing mask on this service or create it if not present
VirtualLicense.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Detail

asAsync

VirtualLicense.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

VirtualLicense.Mask withNewMask()

Description copied from interface: Maskable

Overwrite the existing mask on this service with a new one and return it

Specified by:

withNewMask in interface Maskable

withMask

VirtualLicense.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(VirtualLicense.Mask mask)

getLicenseFile

@ApiMethod(instanceRequired=true)
byte[] getLicenseFile()

Attempt to retrieve the file associated with a virtual license, if such a file exists. If there is no file for this virtual license, calling this method will either throw an exception or return false.

See Also:

SoftLayer_Software_VirtualLicense::getLicenseFile

getObject

@ApiMethod(instanceRequired=true)
VirtualLicense getObject()

getObject retrieves the SoftLayer_Software_VirtualLicense object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Software_VirtualLicense service. You can only retrieve Virtual Licenses assigned to your account number.

See Also:

SoftLayer_Software_VirtualLicense::getObject

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

The customer account this Virtual License belongs to.

See Also:

SoftLayer_Software_VirtualLicense::getAccount

getBillingItem

@ApiMethod(instanceRequired=true)
Item getBillingItem()

The billing item for a software virtual license.

See Also:

SoftLayer_Software_VirtualLicense::getBillingItem

getHostHardware

@ApiMethod(instanceRequired=true)
Server getHostHardware()

The hardware record to which the software virtual license is assigned.

See Also:

SoftLayer_Software_VirtualLicense::getHostHardware

getIpAddressRecord

@ApiMethod(instanceRequired=true)
IpAddress getIpAddressRecord()

The IP Address record associated with a virtual license.

See Also:

SoftLayer_Software_VirtualLicense::getIpAddressRecord

getSoftwareDescription

@ApiMethod(instanceRequired=true)
Description getSoftwareDescription()

The SoftLayer_Software_Description that this virtual license is for.

See Also:

SoftLayer_Software_VirtualLicense::getSoftwareDescription

getSubnet

@ApiMethod(instanceRequired=true)
Subnet getSubnet()

The subnet this Virtual License's IP address belongs to.

See Also:

SoftLayer_Software_VirtualLicense::getSubnet