RequestSecurityToken (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- com.sun.identity.wss.trust.RequestSecurityToken

Direct Known Subclasses:

RequestSecurityToken_Impl, RequestSecurityToken_Impl
```
public abstract class RequestSecurityToken
extends Object
```
This abstract class RequestSecurityToken represents the WS-Trust protocol element RequestSecurityToken.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`ADDRESS`
`protected static String`	`APPLIES_TO`
`protected String`	`appliesTo`
`protected static String`	`CLAIMS`
`protected List<ClaimType>`	`claimTypes`
`protected static String`	`EP_REFERENCE`
`protected static String`	`KEY_TYPE`
`protected String`	`keyType`
`protected Element`	`oboToken`
`protected static String`	`ON_BEHALF_OF`
`protected static String`	`REQUEST_SECURITY_TOKEN`
`protected static String`	`REQUEST_TYPE`
`protected String`	`requestType`
`protected static String`	`TOKEN_TYPE`
`protected String`	`tokenType`

Constructor Summary

Constructors
Constructor and Description

RequestSecurityToken()

Constructors
Constructor and Description
`RequestSecurityToken()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAppliesTo()` Returns the appliesTo attribute.
`List`	`getClaimTypes()` Returns the list of claim types.
`String`	`getKeyType()` Returns the keytype
`Element`	`getOnBehalfOf()` Returns the OnBehalfOf `Element`
`String`	`getRequestType()` Returns the request type
`String`	`getTokenType()` Returns the token type.
`void`	`setAppliesTo(String appliesTo)` Sets the appliesTo attribute.
`void`	`setClaimTypes(List claimTypes)` Sets the list of claim types
`void`	`setKeyType(String keyType)` Sets the keytype
`void`	`setOnBehalfOf(Element oboToken)` Sets the Ob behalf of token.
`void`	`setRequestType(String requestType)` Sets the request type.
`void`	`setTokenType(String tokenType)` Sets the token type.
`abstract Element`	`toDOMElement()` Returns the DOM Element representation for the request security token.
`abstract String`	`toXMLString()` Converts into XML String

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

- Field Detail
  - REQUEST_SECURITY_TOKEN
```
protected static final String REQUEST_SECURITY_TOKEN
```
    See Also:
    
    Constant Field Values
  - REQUEST_TYPE
```
protected static final String REQUEST_TYPE
```
    See Also:
    
    Constant Field Values
  - TOKEN_TYPE
```
protected static final String TOKEN_TYPE
```
    See Also:
    
    Constant Field Values
  - APPLIES_TO
```
protected static final String APPLIES_TO
```
    See Also:
    
    Constant Field Values
  - EP_REFERENCE
```
protected static final String EP_REFERENCE
```
    See Also:
    
    Constant Field Values
  - ADDRESS
```
protected static final String ADDRESS
```
    See Also:
    
    Constant Field Values
  - ON_BEHALF_OF
```
protected static final String ON_BEHALF_OF
```
    See Also:
    
    Constant Field Values
  - KEY_TYPE
```
protected static final String KEY_TYPE
```
    See Also:
    
    Constant Field Values
  - CLAIMS
```
protected static final String CLAIMS
```
    See Also:
    
    Constant Field Values
  - requestType
```
protected String requestType
```
  - appliesTo
```
protected String appliesTo
```
  - oboToken
```
protected Element oboToken
```
  - keyType
```
protected String keyType
```
  - tokenType
```
protected String tokenType
```
  - claimTypes
```
protected List<ClaimType> claimTypes
```
- Constructor Detail
  - RequestSecurityToken
```
public RequestSecurityToken()
```
- Method Detail
  - getRequestType
```
public String getRequestType()
```
    Returns the request type
    
    Returns:
    
    the request type.
  - setRequestType
```
public void setRequestType(String requestType)
```
    Sets the request type.
    
    Parameters:
    
    requestType - the request type
  - getTokenType
```
public String getTokenType()
```
    Returns the token type.
    
    Returns:
    
    the token type.
  - setTokenType
```
public void setTokenType(String tokenType)
```
    Sets the token type.
    
    Parameters:
    
    tokenType - the token type.
  - getAppliesTo
```
public String getAppliesTo()
```
    Returns the appliesTo attribute.
    
    Returns:
    
    the appliesTo attribute
  - setAppliesTo
```
public void setAppliesTo(String appliesTo)
```
    Sets the appliesTo attribute.
    
    Parameters:
    
    appliesTo - the appliesTo attribute.
  - getOnBehalfOf
```
public Element getOnBehalfOf()
```
    Returns the OnBehalfOf Element
    
    Returns:
    
    the OnBehalfOf Element
  - setOnBehalfOf
```
public void setOnBehalfOf(Element oboToken)
```
    Sets the Ob behalf of token.
    
    Parameters:
    
    oboToken - the on behalf of token.
  - getKeyType
```
public String getKeyType()
```
    Returns the keytype
    
    Returns:
    
    the keytype.
  - setKeyType
```
public void setKeyType(String keyType)
```
    Sets the keytype
    
    Parameters:
    
    keyType - the keytype.
  - getClaimTypes
```
public List getClaimTypes()
```
    Returns the list of claim types.
    
    Returns:
    
    the list of claim types.
  - setClaimTypes
```
public void setClaimTypes(List claimTypes)
```
    Sets the list of claim types
    
    Parameters:
    
    claimTypes - the list of claim types.
  - toDOMElement
```
public abstract Element toDOMElement()
                              throws WSTException
```
    Returns the DOM Element representation for the request security token.
    
    Returns:
    
    the DOM Element representation for the request security token.
    
    Throws:
    
    com.sun.identity.wss.sts.protocol.WSTException
    
    WSTException
  - toXMLString
```
public abstract String toXMLString()
                            throws WSTException
```
    Converts into XML String
    
    Returns:
    
    the XML String for RequestSecurityToken.
    
    Throws:
    
    WSTException

Class RequestSecurityToken

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REQUEST_SECURITY_TOKEN

REQUEST_TYPE

TOKEN_TYPE

APPLIES_TO

EP_REFERENCE

ADDRESS

ON_BEHALF_OF

KEY_TYPE

CLAIMS

requestType

appliesTo

oboToken

keyType

tokenType

claimTypes

Constructor Detail

RequestSecurityToken

Method Detail

getRequestType

setRequestType

getTokenType

setTokenType

getAppliesTo

setAppliesTo

getOnBehalfOf

setOnBehalfOf

getKeyType

setKeyType

getClaimTypes

setClaimTypes

toDOMElement

toXMLString