LbJwtAuthAction (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.LbJwtAuthAction

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class LbJwtAuthAction
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
This action is used to control access to backend server resources using JSON Web Token(JWT) authentication. The JWT authentication is done before any HTTP manipulation if the HTTP request matches the given condition in LbRule. Any verification failed, the HTTP process will be terminated, and HTTP response with 401 status code and WWW-Authentication header will be returned to client.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LbJwtAuthAction.Builder
Builder class for LbJwtAuthAction.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`_TYPE_IDENTIFIER` Identifier denoting this class, when it is used in polymorphic context.

Constructor Summary

Constructors
Modifier Constructor and Description

LbJwtAuthAction()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`LbJwtAuthAction()` Default constructor.
`protected`	`LbJwtAuthAction(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 LbJwtAuthAction`	`_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 LbJwtAuthAction`	`_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)`
`com.vmware.vapi.bindings.Structure`	`getKey()`
`java.lang.Boolean`	`getPassJwtToPool()` Specify whether to pass the JWT to backend server or remove it.
`java.lang.String`	`getRealm()` A description of the protected area.
`java.util.List<java.lang.String>`	`getTokens()` JWT is an open standard that defines a compact and self-contained way for securely transmitting information between parties as a JSON object.
`java.lang.String`	`getType()` Possible values are: `LbRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTION` `LbRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTION` `LbRuleAction.TYPE_LBHTTPREJECTACTION` `LbRuleAction.TYPE_LBHTTPREDIRECTACTION` `LbRuleAction.TYPE_LBSELECTPOOLACTION` `LbRuleAction.TYPE_LBSELECTSERVERACTION` `LbRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTION` `LbRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTION` `LbRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTION` `LbRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION` `LbRuleAction.TYPE_LBVARIABLEPERSISTENCEONACTION` `LbRuleAction.TYPE_LBVARIABLEPERSISTENCELEARNACTION` `LbRuleAction.TYPE_LBJWTAUTHACTION` `LbRuleAction.TYPE_LBSSLMODESELECTIONACTION` `LbRuleAction.TYPE_LBCONNECTIONDROPACTION` The property identifies the load balancer rule action type.
`int`	`hashCode()`
`void`	`setKey(com.vmware.vapi.bindings.Structure key)`
`void`	`setPassJwtToPool(java.lang.Boolean passJwtToPool)` Specify whether to pass the JWT to backend server or remove it.
`void`	`setRealm(java.lang.String realm)` A description of the protected area.
`void`	`setTokens(java.util.List<java.lang.String> tokens)` JWT is an open standard that defines a compact and self-contained way for securely transmitting information between parties as a JSON object.
`java.lang.String`	`toString()`

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

- Field Detail
  - _TYPE_IDENTIFIER
```
public static final java.lang.String _TYPE_IDENTIFIER
```
    Identifier denoting this class, when it is used in polymorphic context.
    This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.
    
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - LbJwtAuthAction
```
public LbJwtAuthAction()
```
    Default constructor.
  - LbJwtAuthAction
```
protected LbJwtAuthAction(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getKey
```
public com.vmware.vapi.bindings.Structure getKey()
```
    Returns:
    
    The current value of the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in LbJwtKey. When methods return a value of this class as a return value, the property will contain all the properties defined in LbJwtKey.
  - setKey
```
public void setKey(com.vmware.vapi.bindings.Structure key)
```
    Parameters:
    
    key - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in LbJwtKey. When methods return a value of this class as a return value, the property will contain all the properties defined in LbJwtKey.
  - getPassJwtToPool
```
public java.lang.Boolean getPassJwtToPool()
```
    Specify whether to pass the JWT to backend server or remove it. By default, it is false which means will not pass the JWT to backend servers.
    
    Returns:
    
    The current value of the property.
  - setPassJwtToPool
```
public void setPassJwtToPool(java.lang.Boolean passJwtToPool)
```
    Specify whether to pass the JWT to backend server or remove it. By default, it is false which means will not pass the JWT to backend servers.
    
    Parameters:
    
    passJwtToPool - New value for the property.
  - getRealm
```
public java.lang.String getRealm()
```
    A description of the protected area. If no realm is specified, clients often display a formatted hostname instead. The configured realm is returned when client request is rejected with 401 http status. In the response, it will be \"WWW-Authentication: Bearer realm=\".
    
    Returns:
    
    The current value of the property.
  - setRealm
```
public void setRealm(java.lang.String realm)
```
    A description of the protected area. If no realm is specified, clients often display a formatted hostname instead. The configured realm is returned when client request is rejected with 401 http status. In the response, it will be \"WWW-Authentication: Bearer realm=\".
    
    Parameters:
    
    realm - New value for the property.
  - getTokens
```
public java.util.List<java.lang.String> getTokens()
```
    JWT is an open standard that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. Load balancer will search for every specified tokens one by one for the jwt message until found. This parameter is optional. In case not found or this field is not configured, load balancer searches the Bearer header by default in the http request \"Authorization: Bearer \".
    
    Returns:
    
    The current value of the property.
  - setTokens
```
public void setTokens(java.util.List<java.lang.String> tokens)
```
    JWT is an open standard that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. Load balancer will search for every specified tokens one by one for the jwt message until found. This parameter is optional. In case not found or this field is not configured, load balancer searches the Bearer header by default in the http request \"Authorization: Bearer \".
    
    Parameters:
    
    tokens - New value for the property.
  - getType
```
public java.lang.String getType()
```
    Possible values are:
    The property identifies the load balancer rule action type. The value of this property is automatically populated to "LbJwtAuthAction".
    Returns:
    
    The current value of 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 LbJwtAuthAction _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 LbJwtAuthAction _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class LbJwtAuthAction

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_TYPE_IDENTIFIER

__dynamicStructureFields

Constructor Detail

LbJwtAuthAction

LbJwtAuthAction

Method Detail

getKey

setKey

getPassJwtToPool

setPassJwtToPool

getRealm

setRealm

getTokens

setTokens

getType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2