ALBSAMLSPConfig (Java SDK for NSX Global Policy API 4.1.0.2.0)

java.lang.Object
- com.vmware.nsx_global_policy.model.ALBSAMLSPConfig

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ALBSAMLSPConfig
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Advanced load balancer SAMLSPConfig object

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBSAMLSPConfig.Builder
Builder class for ALBSAMLSPConfig.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ALBSAMLSPConfig.Builder` Builder class for `ALBSAMLSPConfig`.

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

ALBSAMLSPConfig()
Default constructor.

protected ALBSAMLSPConfig(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`ALBSAMLSPConfig()` Default constructor.
`protected`	`ALBSAMLSPConfig(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static ALBSAMLSPConfig`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static ALBSAMLSPConfig`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getCookieName()` HTTP cookie name for authenticated session.
`java.lang.Long`	`getCookieTimeout()` Cookie timeout in minutes.
`java.lang.String`	`getEntityId()` Globally unique SAML entityID for this node.
`java.util.List<ALBHttpCookiePersistenceKey>`	`getKey()` Key to generate the cookie.
`java.lang.String`	`getSigningSslKeyAndCertificatePath()` SP will use this SSL certificate to sign requests going to the IdP and decrypt the assertions coming from IdP.
`java.lang.String`	`getSingleSignonUrl()` SAML Single Signon URL to be programmed on the IDP.
`java.lang.String`	`getSpMetadata()` SAML SP metadata for this application.
`java.lang.Boolean`	`getUseIdpSessionTimeout()` By enabling this field IdP can control how long the SP session can exist through the SessionNotOnOrAfter field in the AuthNStatement of SAML Response.
`int`	`hashCode()`
`void`	`setCookieName(java.lang.String cookieName)` HTTP cookie name for authenticated session.
`void`	`setCookieTimeout(java.lang.Long cookieTimeout)` Cookie timeout in minutes.
`void`	`setEntityId(java.lang.String entityId)` Globally unique SAML entityID for this node.
`void`	`setKey(java.util.List<ALBHttpCookiePersistenceKey> key)` Key to generate the cookie.
`void`	`setSigningSslKeyAndCertificatePath(java.lang.String signingSslKeyAndCertificatePath)` SP will use this SSL certificate to sign requests going to the IdP and decrypt the assertions coming from IdP.
`void`	`setSingleSignonUrl(java.lang.String singleSignonUrl)` SAML Single Signon URL to be programmed on the IDP.
`void`	`setSpMetadata(java.lang.String spMetadata)` SAML SP metadata for this application.
`void`	`setUseIdpSessionTimeout(java.lang.Boolean useIdpSessionTimeout)` By enabling this field IdP can control how long the SP session can exist through the SessionNotOnOrAfter field in the AuthNStatement of SAML Response.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ALBSAMLSPConfig
```
public ALBSAMLSPConfig()
```
    Default constructor.
  - ALBSAMLSPConfig
```
protected ALBSAMLSPConfig(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getCookieName
```
public java.lang.String getCookieName()
```
    HTTP cookie name for authenticated session.
    
    Returns:
    
    The current value of the property.
  - setCookieName
```
public void setCookieName(java.lang.String cookieName)
```
    HTTP cookie name for authenticated session.
    
    Parameters:
    
    cookieName - New value for the property.
  - getCookieTimeout
```
public java.lang.Long getCookieTimeout()
```
    Cookie timeout in minutes. Allowed values are 1-1440. Unit is MIN. Default value when not specified in API or module is interpreted by ALB Controller as 60. format: int64
    
    Returns:
    
    The current value of the property.
  - setCookieTimeout
```
public void setCookieTimeout(java.lang.Long cookieTimeout)
```
    Cookie timeout in minutes. Allowed values are 1-1440. Unit is MIN. Default value when not specified in API or module is interpreted by ALB Controller as 60. format: int64
    
    Parameters:
    
    cookieTimeout - New value for the property.
  - getEntityId
```
public java.lang.String getEntityId()
```
    Globally unique SAML entityID for this node. The SAML application entity ID on the IDP should match this.
    
    Returns:
    
    The current value of the property.
  - setEntityId
```
public void setEntityId(java.lang.String entityId)
```
    Globally unique SAML entityID for this node. The SAML application entity ID on the IDP should match this.
    
    Parameters:
    
    entityId - New value for the property.
  - getKey
```
public java.util.List<ALBHttpCookiePersistenceKey> getKey()
```
    Key to generate the cookie.
    
    Returns:
    
    The current value of the property.
  - setKey
```
public void setKey(java.util.List<ALBHttpCookiePersistenceKey> key)
```
    Key to generate the cookie.
    
    Parameters:
    
    key - New value for the property.
  - getSigningSslKeyAndCertificatePath
```
public java.lang.String getSigningSslKeyAndCertificatePath()
```
    SP will use this SSL certificate to sign requests going to the IdP and decrypt the assertions coming from IdP. It is a reference to an object of type SSLKeyAndCertificate.
    
    Returns:
    
    The current value of the property.
  - setSigningSslKeyAndCertificatePath
```
public void setSigningSslKeyAndCertificatePath(java.lang.String signingSslKeyAndCertificatePath)
```
    SP will use this SSL certificate to sign requests going to the IdP and decrypt the assertions coming from IdP. It is a reference to an object of type SSLKeyAndCertificate.
    
    Parameters:
    
    signingSslKeyAndCertificatePath - New value for the property.
  - getSingleSignonUrl
```
public java.lang.String getSingleSignonUrl()
```
    SAML Single Signon URL to be programmed on the IDP.
    
    Returns:
    
    The current value of the property.
  - setSingleSignonUrl
```
public void setSingleSignonUrl(java.lang.String singleSignonUrl)
```
    SAML Single Signon URL to be programmed on the IDP.
    
    Parameters:
    
    singleSignonUrl - New value for the property.
  - getSpMetadata
```
public java.lang.String getSpMetadata()
```
    SAML SP metadata for this application.
    
    Returns:
    
    The current value of the property.
  - setSpMetadata
```
public void setSpMetadata(java.lang.String spMetadata)
```
    SAML SP metadata for this application.
    
    Parameters:
    
    spMetadata - New value for the property.
  - getUseIdpSessionTimeout
```
public java.lang.Boolean getUseIdpSessionTimeout()
```
    By enabling this field IdP can control how long the SP session can exist through the SessionNotOnOrAfter field in the AuthNStatement of SAML Response.
    
    Returns:
    
    The current value of the property.
  - setUseIdpSessionTimeout
```
public void setUseIdpSessionTimeout(java.lang.Boolean useIdpSessionTimeout)
```
    By enabling this field IdP can control how long the SP session can exist through the SessionNotOnOrAfter field in the AuthNStatement of SAML Response.
    
    Parameters:
    
    useIdpSessionTimeout - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static ALBSAMLSPConfig _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static ALBSAMLSPConfig _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBSAMLSPConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

ALBSAMLSPConfig

ALBSAMLSPConfig

Method Detail

getCookieName

setCookieName

getCookieTimeout

setCookieTimeout

getEntityId

setEntityId

getKey

setKey

getSigningSslKeyAndCertificatePath

setSigningSslKeyAndCertificatePath

getSingleSignonUrl

setSingleSignonUrl

getSpMetadata

setSpMetadata

getUseIdpSessionTimeout

setUseIdpSessionTimeout

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2