Package com.softlayer.api.service.network.tunnel.module

Class Context

java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.network.tunnel.module.Context
@ApiType("SoftLayer_Network_Tunnel_Module_Context")
public class Context
extends Entity
The SoftLayer_Network_Tunnel_Module_Context data type contains general information relating to a single SoftLayer network tunnel. The SoftLayer_Network_Tunnel_Module_Context is useful to gather information such as related customer subnets (remote) and internal subnets (local) associated with the network tunnel as well as other information needed to manage the network tunnel. Account and billing information related to the network tunnel can also be retrieved.
See Also:
SoftLayer_Network_Tunnel_Module_Context

  • Field Details

    • account

      @ApiProperty protected Account account
      The account that a network tunnel belongs to.

    • activeTransaction

      @ApiProperty protected Transaction activeTransaction
      The transaction that is currently applying configurations for the network tunnel.

    • addressTranslations

      @ApiProperty protected List<Translation> addressTranslations
      A network tunnel's address translations.

    • allAvailableServiceSubnets

      @ApiProperty protected List<Subnet> allAvailableServiceSubnets
      Subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API.

    • billingItem

      @ApiProperty protected Item billingItem
      The current billing item for network tunnel.

    • customerSubnets

      @ApiProperty protected List<Subnet> customerSubnets
      Remote subnets that are allowed access through a network tunnel.

    • datacenter

      @ApiProperty protected Location datacenter
      The datacenter location for one end of the network tunnel that allows access to account's private subnets.

    • internalSubnets

      @ApiProperty protected List<Subnet> internalSubnets
      Private subnets that can be accessed through the network tunnel.

    • serviceSubnets

      @ApiProperty protected List<Subnet> serviceSubnets
      Service subnets that can be access through the network tunnel.

    • staticRouteSubnets

      @ApiProperty protected List<Subnet> staticRouteSubnets
      Subnets used for a network tunnel's address translations.

    • transactionHistory

      @ApiProperty protected List<Transaction> transactionHistory
      The transaction history for this network tunnel.

    • accountId

      @ApiProperty(canBeNullOrNotSet=true) protected Long accountId
      A network tunnel's account identifier.

    • accountIdSpecified

      protected boolean accountIdSpecified

    • advancedConfigurationFlag

      @ApiProperty(canBeNullOrNotSet=true) protected Long advancedConfigurationFlag
      A flag used to specify when advanced configurations, complex configurations that require manual setup, are being applied to network devices for a network tunnel. When the flag is set to true (1), a network tunnel cannot be configured through the management portal nor the API.

    • advancedConfigurationFlagSpecified

      protected boolean advancedConfigurationFlagSpecified

    • createDate

      @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar createDate
      The date a network tunnel was created.

    • createDateSpecified

      protected boolean createDateSpecified

    • customerPeerIpAddress

      @ApiProperty(canBeNullOrNotSet=true) protected String customerPeerIpAddress
      The remote end of a network tunnel. This end of the network tunnel resides on an outside network and will be sending and receiving the IPSec packets.

    • customerPeerIpAddressSpecified

      protected boolean customerPeerIpAddressSpecified

    • friendlyName

      @ApiProperty(canBeNullOrNotSet=true) protected String friendlyName
      The name giving to a network tunnel by a user.

    • friendlyNameSpecified

      protected boolean friendlyNameSpecified

    • id

      @ApiProperty(canBeNullOrNotSet=true) protected Long id
      A network tunnel's unique identifier.

    • idSpecified

      protected boolean idSpecified

    • internalPeerIpAddress

      @ApiProperty(canBeNullOrNotSet=true) protected String internalPeerIpAddress
      The local end of a network tunnel. This end of the network tunnel resides on the SoftLayer networks and allows access to remote end of the tunnel to subnets on SoftLayer networks.

    • internalPeerIpAddressSpecified

      protected boolean internalPeerIpAddressSpecified

    • modifyDate

      @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar modifyDate
      The date a network tunnel was last modified.

      NOTE: This date should NOT be used to determine when the network tunnel configurations were last applied to the network device.

    • modifyDateSpecified

      protected boolean modifyDateSpecified

    • name

      @ApiProperty(canBeNullOrNotSet=true) protected String name
      A network tunnel's unique name used on the network device.

    • nameSpecified

      protected boolean nameSpecified

    • phaseOneAuthentication

      @ApiProperty(canBeNullOrNotSet=true) protected String phaseOneAuthentication
      Authentication used to generate keys for protecting the negotiations for a network tunnel.

    • phaseOneAuthenticationSpecified

      protected boolean phaseOneAuthenticationSpecified

    • phaseOneDiffieHellmanGroup

      @ApiProperty(canBeNullOrNotSet=true) protected Long phaseOneDiffieHellmanGroup
      Determines the strength of the key used in the key exchange process. The higher the group number the stronger the key is and the more secure it is. However, processing time will increase as the strength of the key increases. Both peers in the must use the Diffie-Hellman Group.

    • phaseOneDiffieHellmanGroupSpecified

      protected boolean phaseOneDiffieHellmanGroupSpecified

    • phaseOneEncryption

      @ApiProperty(canBeNullOrNotSet=true) protected String phaseOneEncryption
      Encryption used to generate keys for protecting the negotiations for a network tunnel.

    • phaseOneEncryptionSpecified

      protected boolean phaseOneEncryptionSpecified

    • phaseOneKeylife

      @ApiProperty(canBeNullOrNotSet=true) protected Long phaseOneKeylife
      Amount of time (in seconds) allowed to pass before the encryption key expires. A new key is generated without interrupting service. Valid times are from 120 to 172800 seconds.

    • phaseOneKeylifeSpecified

      protected boolean phaseOneKeylifeSpecified

    • phaseTwoAuthentication

      @ApiProperty(canBeNullOrNotSet=true) protected String phaseTwoAuthentication
      The authentication used in phase 2 proposal negotiation process.

    • phaseTwoAuthenticationSpecified

      protected boolean phaseTwoAuthenticationSpecified

    • phaseTwoDiffieHellmanGroup

      @ApiProperty(canBeNullOrNotSet=true) protected Long phaseTwoDiffieHellmanGroup
      Determines the strength of the key used in the key exchange process. The higher the group number the stronger the key is and the more secure it is. However, processing time will increase as the strength of the key increases. Both peers must use the Diffie-Hellman Group.

    • phaseTwoDiffieHellmanGroupSpecified

      protected boolean phaseTwoDiffieHellmanGroupSpecified

    • phaseTwoEncryption

      @ApiProperty(canBeNullOrNotSet=true) protected String phaseTwoEncryption
      The encryption used in phase 2 proposal negotiation process.

    • phaseTwoEncryptionSpecified

      protected boolean phaseTwoEncryptionSpecified

    • phaseTwoKeylife

      @ApiProperty(canBeNullOrNotSet=true) protected Long phaseTwoKeylife
      Amount of time (in seconds) allowed to pass before the encryption key expires. A new key is generated without interrupting service. Valid times are from 120 to 172800 seconds.

    • phaseTwoKeylifeSpecified

      protected boolean phaseTwoKeylifeSpecified

    • phaseTwoPerfectForwardSecrecy

      @ApiProperty(canBeNullOrNotSet=true) protected Long phaseTwoPerfectForwardSecrecy
      Determines if the generated keys are made from previous keys. When PFS is specified, a Diffie-Hellman exchange occurs each time a new security association is negotiated.

    • phaseTwoPerfectForwardSecrecySpecified

      protected boolean phaseTwoPerfectForwardSecrecySpecified

    • presharedKey

      @ApiProperty(canBeNullOrNotSet=true) protected String presharedKey
      A key used so that peers authenticate each other. This key is hashed by using the phase one encryption and phase one authentication.

    • presharedKeySpecified

      protected boolean presharedKeySpecified

    • addressTranslationCount

      @ApiProperty protected Long addressTranslationCount
      A count of a network tunnel's address translations.

    • allAvailableServiceSubnetCount

      @ApiProperty protected Long allAvailableServiceSubnetCount
      A count of subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API.

    • customerSubnetCount

      @ApiProperty protected Long customerSubnetCount
      A count of remote subnets that are allowed access through a network tunnel.

    • internalSubnetCount

      @ApiProperty protected Long internalSubnetCount
      A count of private subnets that can be accessed through the network tunnel.

    • serviceSubnetCount

      @ApiProperty protected Long serviceSubnetCount
      A count of service subnets that can be access through the network tunnel.

    • staticRouteSubnetCount

      @ApiProperty protected Long staticRouteSubnetCount
      A count of subnets used for a network tunnel's address translations.

    • transactionHistoryCount

      @ApiProperty protected Long transactionHistoryCount
      A count of the transaction history for this network tunnel.

  • Constructor Details

    • Context

      public Context()

  • Method Details

    • getAccount

      public Account getAccount()

    • setAccount

      public void setAccount​(Account account)

    • getActiveTransaction

      public Transaction getActiveTransaction()

    • setActiveTransaction

      public void setActiveTransaction​(Transaction activeTransaction)

    • getAddressTranslations

      public List<Translation> getAddressTranslations()

    • getAllAvailableServiceSubnets

      public List<Subnet> getAllAvailableServiceSubnets()

    • getBillingItem

      public Item getBillingItem()

    • setBillingItem

      public void setBillingItem​(Item billingItem)

    • getCustomerSubnets

      public List<Subnet> getCustomerSubnets()

    • getDatacenter

      public Location getDatacenter()

    • setDatacenter

      public void setDatacenter​(Location datacenter)

    • getInternalSubnets

      public List<Subnet> getInternalSubnets()

    • getServiceSubnets

      public List<Subnet> getServiceSubnets()

    • getStaticRouteSubnets

      public List<Subnet> getStaticRouteSubnets()

    • getTransactionHistory

      public List<Transaction> getTransactionHistory()

    • getAccountId

      public Long getAccountId()

    • setAccountId

      public void setAccountId​(Long accountId)

    • isAccountIdSpecified

      public boolean isAccountIdSpecified()

    • unsetAccountId

      public void unsetAccountId()

    • getAdvancedConfigurationFlag

      public Long getAdvancedConfigurationFlag()

    • setAdvancedConfigurationFlag

      public void setAdvancedConfigurationFlag​(Long advancedConfigurationFlag)

    • isAdvancedConfigurationFlagSpecified

      public boolean isAdvancedConfigurationFlagSpecified()

    • unsetAdvancedConfigurationFlag

      public void unsetAdvancedConfigurationFlag()

    • getCreateDate

      public GregorianCalendar getCreateDate()

    • setCreateDate

      public void setCreateDate​(GregorianCalendar createDate)

    • isCreateDateSpecified

      public boolean isCreateDateSpecified()

    • unsetCreateDate

      public void unsetCreateDate()

    • getCustomerPeerIpAddress

      public String getCustomerPeerIpAddress()

    • setCustomerPeerIpAddress

      public void setCustomerPeerIpAddress​(String customerPeerIpAddress)

    • isCustomerPeerIpAddressSpecified

      public boolean isCustomerPeerIpAddressSpecified()

    • unsetCustomerPeerIpAddress

      public void unsetCustomerPeerIpAddress()

    • getFriendlyName

      public String getFriendlyName()

    • setFriendlyName

      public void setFriendlyName​(String friendlyName)

    • isFriendlyNameSpecified

      public boolean isFriendlyNameSpecified()

    • unsetFriendlyName

      public void unsetFriendlyName()

    • getId

      public Long getId()

    • setId

      public void setId​(Long id)

    • isIdSpecified

      public boolean isIdSpecified()

    • unsetId

      public void unsetId()

    • getInternalPeerIpAddress

      public String getInternalPeerIpAddress()

    • setInternalPeerIpAddress

      public void setInternalPeerIpAddress​(String internalPeerIpAddress)

    • isInternalPeerIpAddressSpecified

      public boolean isInternalPeerIpAddressSpecified()

    • unsetInternalPeerIpAddress

      public void unsetInternalPeerIpAddress()

    • getModifyDate

      public GregorianCalendar getModifyDate()

    • setModifyDate

      public void setModifyDate​(GregorianCalendar modifyDate)

    • isModifyDateSpecified

      public boolean isModifyDateSpecified()

    • unsetModifyDate

      public void unsetModifyDate()

    • getName

      public String getName()

    • setName

      public void setName​(String name)

    • isNameSpecified

      public boolean isNameSpecified()

    • unsetName

      public void unsetName()

    • getPhaseOneAuthentication

      public String getPhaseOneAuthentication()

    • setPhaseOneAuthentication

      public void setPhaseOneAuthentication​(String phaseOneAuthentication)

    • isPhaseOneAuthenticationSpecified

      public boolean isPhaseOneAuthenticationSpecified()

    • unsetPhaseOneAuthentication

      public void unsetPhaseOneAuthentication()

    • getPhaseOneDiffieHellmanGroup

      public Long getPhaseOneDiffieHellmanGroup()

    • setPhaseOneDiffieHellmanGroup

      public void setPhaseOneDiffieHellmanGroup​(Long phaseOneDiffieHellmanGroup)

    • isPhaseOneDiffieHellmanGroupSpecified

      public boolean isPhaseOneDiffieHellmanGroupSpecified()

    • unsetPhaseOneDiffieHellmanGroup

      public void unsetPhaseOneDiffieHellmanGroup()

    • getPhaseOneEncryption

      public String getPhaseOneEncryption()

    • setPhaseOneEncryption

      public void setPhaseOneEncryption​(String phaseOneEncryption)

    • isPhaseOneEncryptionSpecified

      public boolean isPhaseOneEncryptionSpecified()

    • unsetPhaseOneEncryption

      public void unsetPhaseOneEncryption()

    • getPhaseOneKeylife

      public Long getPhaseOneKeylife()

    • setPhaseOneKeylife

      public void setPhaseOneKeylife​(Long phaseOneKeylife)

    • isPhaseOneKeylifeSpecified

      public boolean isPhaseOneKeylifeSpecified()

    • unsetPhaseOneKeylife

      public void unsetPhaseOneKeylife()

    • getPhaseTwoAuthentication

      public String getPhaseTwoAuthentication()

    • setPhaseTwoAuthentication

      public void setPhaseTwoAuthentication​(String phaseTwoAuthentication)

    • isPhaseTwoAuthenticationSpecified

      public boolean isPhaseTwoAuthenticationSpecified()

    • unsetPhaseTwoAuthentication

      public void unsetPhaseTwoAuthentication()

    • getPhaseTwoDiffieHellmanGroup

      public Long getPhaseTwoDiffieHellmanGroup()

    • setPhaseTwoDiffieHellmanGroup

      public void setPhaseTwoDiffieHellmanGroup​(Long phaseTwoDiffieHellmanGroup)

    • isPhaseTwoDiffieHellmanGroupSpecified

      public boolean isPhaseTwoDiffieHellmanGroupSpecified()

    • unsetPhaseTwoDiffieHellmanGroup

      public void unsetPhaseTwoDiffieHellmanGroup()

    • getPhaseTwoEncryption

      public String getPhaseTwoEncryption()

    • setPhaseTwoEncryption

      public void setPhaseTwoEncryption​(String phaseTwoEncryption)

    • isPhaseTwoEncryptionSpecified

      public boolean isPhaseTwoEncryptionSpecified()

    • unsetPhaseTwoEncryption

      public void unsetPhaseTwoEncryption()

    • getPhaseTwoKeylife

      public Long getPhaseTwoKeylife()

    • setPhaseTwoKeylife

      public void setPhaseTwoKeylife​(Long phaseTwoKeylife)

    • isPhaseTwoKeylifeSpecified

      public boolean isPhaseTwoKeylifeSpecified()

    • unsetPhaseTwoKeylife

      public void unsetPhaseTwoKeylife()

    • getPhaseTwoPerfectForwardSecrecy

      public Long getPhaseTwoPerfectForwardSecrecy()

    • setPhaseTwoPerfectForwardSecrecy

      public void setPhaseTwoPerfectForwardSecrecy​(Long phaseTwoPerfectForwardSecrecy)

    • isPhaseTwoPerfectForwardSecrecySpecified

      public boolean isPhaseTwoPerfectForwardSecrecySpecified()

    • unsetPhaseTwoPerfectForwardSecrecy

      public void unsetPhaseTwoPerfectForwardSecrecy()

    • getPresharedKey

      public String getPresharedKey()

    • setPresharedKey

      public void setPresharedKey​(String presharedKey)

    • isPresharedKeySpecified

      public boolean isPresharedKeySpecified()

    • unsetPresharedKey

      public void unsetPresharedKey()

    • getAddressTranslationCount

      public Long getAddressTranslationCount()

    • setAddressTranslationCount

      public void setAddressTranslationCount​(Long addressTranslationCount)

    • getAllAvailableServiceSubnetCount

      public Long getAllAvailableServiceSubnetCount()

    • setAllAvailableServiceSubnetCount

      public void setAllAvailableServiceSubnetCount​(Long allAvailableServiceSubnetCount)

    • getCustomerSubnetCount

      public Long getCustomerSubnetCount()

    • setCustomerSubnetCount

      public void setCustomerSubnetCount​(Long customerSubnetCount)

    • getInternalSubnetCount

      public Long getInternalSubnetCount()

    • setInternalSubnetCount

      public void setInternalSubnetCount​(Long internalSubnetCount)

    • getServiceSubnetCount

      public Long getServiceSubnetCount()

    • setServiceSubnetCount

      public void setServiceSubnetCount​(Long serviceSubnetCount)

    • getStaticRouteSubnetCount

      public Long getStaticRouteSubnetCount()

    • setStaticRouteSubnetCount

      public void setStaticRouteSubnetCount​(Long staticRouteSubnetCount)

    • getTransactionHistoryCount

      public Long getTransactionHistoryCount()

    • setTransactionHistoryCount

      public void setTransactionHistoryCount​(Long transactionHistoryCount)

    • asService

      public Context.Service asService​(ApiClient client)

    • service

      public static Context.Service service​(ApiClient client)

    • service

      public static Context.Service service​(ApiClient client, Long id)