com.softlayer.api.service.container.network.cdnmarketplace.configuration.behavior.TokenAuth

@ApiType("SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth")
public class TokenAuth
extends Entity

The SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth data type contains information for specific responses from the Token Authentication API.

See Also:: SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class TokenAuth.Mask

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`aclDelimiter`	Specifies a single character to separate access control list (ACL) fields.
`protected boolean`	`aclDelimiterSpecified`
`protected String`	`escapeTokenInputs`	Possible values '0' and '1'.
`protected boolean`	`escapeTokenInputsSpecified`
`protected String`	`hmacAlgorithm`	Specifies the algorithm to use for the token's hash-based message authentication code (HMAC) field.
`protected boolean`	`hmacAlgorithmSpecified`
`protected String`	`ignoreQueryString`	Possible values '0' and '1'.
`protected boolean`	`ignoreQueryStringSpecified`
`protected String`	`name`	The token name.
`protected boolean`	`nameSpecified`
`protected String`	`path`	The path, relative to the domain that is accessed via token authentication.
`protected boolean`	`pathSpecified`
`protected String`	`tokenDelimiter`	Specifies a single character to separate the individual token fields.
`protected boolean`	`tokenDelimiterSpecified`
`protected String`	`tokenKey`	The token encryption key, which specifies an even number of hex digits for the token key.
`protected boolean`	`tokenKeySpecified`
`protected String`	`transitionKey`	The token transition key, which specifies an even number of hex digits for the token transition key.
`protected boolean`	`transitionKeySpecified`
`protected String`	`uniqueId`	The uniqueId of the mapping to which the existing behavior belongs.
`protected boolean`	`uniqueIdSpecified`

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

TokenAuth()

Method Summary

Modifier and Type	Method	Description
`String`	`getAclDelimiter()`
`String`	`getEscapeTokenInputs()`
`String`	`getHmacAlgorithm()`
`String`	`getIgnoreQueryString()`
`String`	`getName()`
`String`	`getPath()`
`String`	`getTokenDelimiter()`
`String`	`getTokenKey()`
`String`	`getTransitionKey()`
`String`	`getUniqueId()`
`boolean`	`isAclDelimiterSpecified()`
`boolean`	`isEscapeTokenInputsSpecified()`
`boolean`	`isHmacAlgorithmSpecified()`
`boolean`	`isIgnoreQueryStringSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isPathSpecified()`
`boolean`	`isTokenDelimiterSpecified()`
`boolean`	`isTokenKeySpecified()`
`boolean`	`isTransitionKeySpecified()`
`boolean`	`isUniqueIdSpecified()`
`void`	`setAclDelimiter(String aclDelimiter)`
`void`	`setEscapeTokenInputs(String escapeTokenInputs)`
`void`	`setHmacAlgorithm(String hmacAlgorithm)`
`void`	`setIgnoreQueryString(String ignoreQueryString)`
`void`	`setName(String name)`
`void`	`setPath(String path)`
`void`	`setTokenDelimiter(String tokenDelimiter)`
`void`	`setTokenKey(String tokenKey)`
`void`	`setTransitionKey(String transitionKey)`
`void`	`setUniqueId(String uniqueId)`
`void`	`unsetAclDelimiter()`
`void`	`unsetEscapeTokenInputs()`
`void`	`unsetHmacAlgorithm()`
`void`	`unsetIgnoreQueryString()`
`void`	`unsetName()`
`void`	`unsetPath()`
`void`	`unsetTokenDelimiter()`
`void`	`unsetTokenKey()`
`void`	`unsetTransitionKey()`
`void`	`unsetUniqueId()`

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- aclDelimiter
  
  @ApiProperty(canBeNullOrNotSet=true) protected String aclDelimiter
  
  Specifies a single character to separate access control list (ACL) fields. The default value is '!'.
- aclDelimiterSpecified
  
  protected boolean aclDelimiterSpecified
- escapeTokenInputs
  
  @ApiProperty(canBeNullOrNotSet=true) protected String escapeTokenInputs
  
  Possible values '0' and '1'. If set to '1', input values are escaped before adding them to the token. Default value is '1'.
- escapeTokenInputsSpecified
  
  protected boolean escapeTokenInputsSpecified
- hmacAlgorithm
  
  @ApiProperty(canBeNullOrNotSet=true) protected String hmacAlgorithm
  
  Specifies the algorithm to use for the token's hash-based message authentication code (HMAC) field. Valid entries are 'SHA256', 'SHA1', or 'MD5'. The default value is 'SHA256'.
- hmacAlgorithmSpecified
  
  protected boolean hmacAlgorithmSpecified
- ignoreQueryString
  
  @ApiProperty(canBeNullOrNotSet=true) protected String ignoreQueryString
  
  Possible values '0' and '1'. If set to '1', query strings are removed from a URL when computing the token's HMAC algorithm. Default value is '0'.
- ignoreQueryStringSpecified
  
  protected boolean ignoreQueryStringSpecified
- name
  
  @ApiProperty(canBeNullOrNotSet=true) protected String name
  
  The token name. If this value is empty, then it is set to the default value '__token__'.
- nameSpecified
  
  protected boolean nameSpecified
- path
  
  @ApiProperty(canBeNullOrNotSet=true) protected String path
  
  The path, relative to the domain that is accessed via token authentication.
- pathSpecified
  
  protected boolean pathSpecified
- tokenDelimiter
  
  @ApiProperty(canBeNullOrNotSet=true) protected String tokenDelimiter
  
  Specifies a single character to separate the individual token fields. The default value is '~'.
- tokenDelimiterSpecified
  
  protected boolean tokenDelimiterSpecified
- tokenKey
  
  @ApiProperty(canBeNullOrNotSet=true) protected String tokenKey
  
  The token encryption key, which specifies an even number of hex digits for the token key. An entry can be up to 64 characters in length.
- tokenKeySpecified
  
  protected boolean tokenKeySpecified
- transitionKey
  
  @ApiProperty(canBeNullOrNotSet=true) protected String transitionKey
  
  The token transition key, which specifies an even number of hex digits for the token transition key. An entry can be up to 64 characters in length.
- transitionKeySpecified
  
  protected boolean transitionKeySpecified
- uniqueId
  
  @ApiProperty(canBeNullOrNotSet=true) protected String uniqueId
  
  The uniqueId of the mapping to which the existing behavior belongs.
- uniqueIdSpecified
  
  protected boolean uniqueIdSpecified
Constructor Details
- TokenAuth
  
  public TokenAuth()
Method Details
- getAclDelimiter
  
  public String getAclDelimiter()
- setAclDelimiter
  
  public void setAclDelimiter(String aclDelimiter)
- isAclDelimiterSpecified
  
  public boolean isAclDelimiterSpecified()
- unsetAclDelimiter
  
  public void unsetAclDelimiter()
- getEscapeTokenInputs
  
  public String getEscapeTokenInputs()
- setEscapeTokenInputs
  
  public void setEscapeTokenInputs(String escapeTokenInputs)
- isEscapeTokenInputsSpecified
  
  public boolean isEscapeTokenInputsSpecified()
- unsetEscapeTokenInputs
  
  public void unsetEscapeTokenInputs()
- getHmacAlgorithm
  
  public String getHmacAlgorithm()
- setHmacAlgorithm
  
  public void setHmacAlgorithm(String hmacAlgorithm)
- isHmacAlgorithmSpecified
  
  public boolean isHmacAlgorithmSpecified()
- unsetHmacAlgorithm
  
  public void unsetHmacAlgorithm()
- getIgnoreQueryString
  
  public String getIgnoreQueryString()
- setIgnoreQueryString
  
  public void setIgnoreQueryString(String ignoreQueryString)
- isIgnoreQueryStringSpecified
  
  public boolean isIgnoreQueryStringSpecified()
- unsetIgnoreQueryString
  
  public void unsetIgnoreQueryString()
- getName
  
  public String getName()
- setName
  
  public void setName(String name)
- isNameSpecified
  
  public boolean isNameSpecified()
- unsetName
  
  public void unsetName()
- getPath
  
  public String getPath()
- setPath
  
  public void setPath(String path)
- isPathSpecified
  
  public boolean isPathSpecified()
- unsetPath
  
  public void unsetPath()
- getTokenDelimiter
  
  public String getTokenDelimiter()
- setTokenDelimiter
  
  public void setTokenDelimiter(String tokenDelimiter)
- isTokenDelimiterSpecified
  
  public boolean isTokenDelimiterSpecified()
- unsetTokenDelimiter
  
  public void unsetTokenDelimiter()
- getTokenKey
  
  public String getTokenKey()
- setTokenKey
  
  public void setTokenKey(String tokenKey)
- isTokenKeySpecified
  
  public boolean isTokenKeySpecified()
- unsetTokenKey
  
  public void unsetTokenKey()
- getTransitionKey
  
  public String getTransitionKey()
- setTransitionKey
  
  public void setTransitionKey(String transitionKey)
- isTransitionKeySpecified
  
  public boolean isTransitionKeySpecified()
- unsetTransitionKey
  
  public void unsetTransitionKey()
- getUniqueId
  
  public String getUniqueId()
- setUniqueId
  
  public void setUniqueId(String uniqueId)
- isUniqueIdSpecified
  
  public boolean isUniqueIdSpecified()
- unsetUniqueId
  
  public void unsetUniqueId()

Class TokenAuth

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details