AbstractStsRealm (DDF Reactor 2.11.5 API)

java.lang.Object
- org.apache.shiro.realm.CachingRealm
- - org.apache.shiro.realm.AuthenticatingRealm
  - - ddf.security.realm.sts.AbstractStsRealm

All Implemented Interfaces:

STSClientConfiguration, org.apache.shiro.authc.LogoutAware, org.apache.shiro.cache.CacheManagerAware, org.apache.shiro.realm.Realm, org.apache.shiro.util.Initializable, org.apache.shiro.util.Nameable

Direct Known Subclasses:

StsRealm, WssStsRealm
```
public abstract class AbstractStsRealm
extends org.apache.shiro.realm.AuthenticatingRealm
implements STSClientConfiguration
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AbstractStsRealm.STSCredentialsMatcher` Credentials matcher class that ensures the AuthInfo received from the STS matches the AuthToken

Field Summary

Fields
Modifier and Type Field and Description

protected org.apache.cxf.Bus bus

Fields
Modifier and Type	Field and Description
`protected org.apache.cxf.Bus`	`bus`

Constructor Summary

Constructors
Constructor and Description

AbstractStsRealm()

Constructors
Constructor and Description
`AbstractStsRealm()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected org.apache.cxf.ws.security.trust.STSClient`	`configureStsClient()` Helper method to setup STS Client.
`protected Element`	`createClaimsElement()` Create the claims element with the claims provided in the STS client configuration in the admin console.
`protected org.apache.shiro.authc.AuthenticationInfo`	`doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken token)` Perform authentication based on the supplied token.
`String`	`getAddress()` Retrieves the address of the STS server.
`String`	`getAssertionType()` Retrieves the assertion type that should be requested from the STS.
`protected org.apache.cxf.Bus`	`getBus()` Helper method to setup STS Client.
`List<String>`	`getClaims()` Retrieves the list of claims that should be requested from the STS.
`ContextPolicyManager`	`getContextPolicyManager()`
`String`	`getEncryptionProperties()` Per WS-Security Policy:
`String`	`getEncryptionUsername()` Per WS-Security Policy:
`String`	`getEndpointName()` Retrieves the endpoint name of the STS service.
`String`	`getKeySize()` Retrieves the size of the key that should be used.
`String`	`getKeyType()` Retrieves the key type that should be used when communicating with the STS.
`String`	`getPassword()` Retrieves the password for the associated username set in `#setUsername()`
`String`	`getServiceName()` Retrieves the service name of the STS service.
`String`	`getSignatureProperties()` Per WS-Security Policy:
`String`	`getSignatureUsername()` Per WS-Security Policy:
`String`	`getTokenProperties()` Per WS-Security Policy:
`String`	`getTokenUsername()` Per WS-Security Policy:
`Boolean`	`getUseKey()` Flags whether or not to supply a key in the request.
`String`	`getUsername()` Retrieves the user's name for performing operations on the STS.
`protected org.apache.cxf.ws.security.tokenstore.SecurityToken`	`renewSecurityToken(org.apache.cxf.ws.security.tokenstore.SecurityToken securityToken)` Renew a security token (SAML assertion) from the STS.
`protected org.apache.cxf.ws.security.tokenstore.SecurityToken`	`requestSecurityToken(Object authToken)` Request a security token (SAML assertion) from the STS.
`void`	`setAddress(String address)` Sets the address of the STS server.
`void`	`setAssertionType(String assertionType)` Sets the assertion type that should be requested from the STS.
`void`	`setClaims(List<String> claims)` Sets the claim list with the incoming list.
`void`	`setClaims(String claimsListAsString)` Sets the claim list with the incoming comma-delimieted string of URI values.
`void`	`setContextPolicyManager(ContextPolicyManager contextPolicyManager)`
`void`	`setEncryptionProperties(String encryptionProperties)` Sets the location of the encryption properties file.
`void`	`setEncryptionUsername(String encryptionUsername)` Sets the user's name for encryption.
`void`	`setEndpointName(String endpointName)` Sets the endpoint name of the STS service.
`void`	`setKeySize(String keySize)` Sets the size of the key that should be used.
`void`	`setKeyType(String keyType)` Sets the key type that should be used when communicating with the STS.
`void`	`setPassword(String password)` Sets the password for the current user.
`void`	`setServiceName(String serviceName)` Sets the service name of the STS service.
`void`	`setSignatureProperties(String signatureProperties)` Sets the location of the signature properties file.
`void`	`setSignatureUsername(String signatureUsername)` Sets the user's signature name.
`void`	`setTokenProperties(String tokenProperties)` Sets the location of the token properties file.
`void`	`setTokenUsername(String tokenUsername)` Sets the alias name for the user's public key.
`void`	`setUseKey(Boolean useKey)` Sets whether or not to supply a key in the request.
`void`	`setUsername(String username)` Sets the user's name to use for performing STS operations.
`protected abstract boolean`	`shouldHandleWss()`
`boolean`	`supports(org.apache.shiro.authc.AuthenticationToken token)` Determine if the supplied token is supported by this realm.

Methods inherited from class org.apache.shiro.realm.AuthenticatingRealm
afterCacheManagerSet, assertCredentialsMatch, clearCachedAuthenticationInfo, doClearCache, getAuthenticationCache, getAuthenticationCacheKey, getAuthenticationCacheKey, getAuthenticationCacheName, getAuthenticationInfo, getAuthenticationTokenClass, getCredentialsMatcher, init, isAuthenticationCachingEnabled, isAuthenticationCachingEnabled, onInit, setAuthenticationCache, setAuthenticationCacheName, setAuthenticationCachingEnabled, setAuthenticationTokenClass, setCredentialsMatcher, setName

Methods inherited from class org.apache.shiro.realm.CachingRealm
clearCache, getAvailablePrincipal, getCacheManager, getName, isCachingEnabled, onLogout, setCacheManager, setCachingEnabled

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

- Field Detail
  - bus
```
protected org.apache.cxf.Bus bus
```
- Constructor Detail
  - AbstractStsRealm
```
public AbstractStsRealm()
```
- Method Detail
  - getContextPolicyManager
```
public ContextPolicyManager getContextPolicyManager()
```
  - setContextPolicyManager
```
public void setContextPolicyManager(ContextPolicyManager contextPolicyManager)
```
  - supports
```
public boolean supports(org.apache.shiro.authc.AuthenticationToken token)
```
    Determine if the supplied token is supported by this realm.
    
    Specified by:
    
    supports in interface org.apache.shiro.realm.Realm
    
    Overrides:
    
    supports in class org.apache.shiro.realm.AuthenticatingRealm
  - shouldHandleWss
```
protected abstract boolean shouldHandleWss()
```
  - doGetAuthenticationInfo
```
protected org.apache.shiro.authc.AuthenticationInfo doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken token)
```
    Perform authentication based on the supplied token.
    
    Specified by:
    
    doGetAuthenticationInfo in class org.apache.shiro.realm.AuthenticatingRealm
  - requestSecurityToken
```
protected org.apache.cxf.ws.security.tokenstore.SecurityToken requestSecurityToken(Object authToken)
```
    Request a security token (SAML assertion) from the STS.
    
    Parameters:
    
    authToken - The subject the security token is being request for.
    
    Returns:
    
    security token (SAML assertion)
  - renewSecurityToken
```
protected org.apache.cxf.ws.security.tokenstore.SecurityToken renewSecurityToken(org.apache.cxf.ws.security.tokenstore.SecurityToken securityToken)
```
    Renew a security token (SAML assertion) from the STS.
    
    Parameters:
    
    securityToken - The token being renewed.
    
    Returns:
    
    security token (SAML assertion)
  - getBus
```
protected org.apache.cxf.Bus getBus()
```
    Helper method to setup STS Client.
  - configureStsClient
```
protected org.apache.cxf.ws.security.trust.STSClient configureStsClient()
```
    Helper method to setup STS Client.
  - createClaimsElement
```
protected Element createClaimsElement()
```
    Create the claims element with the claims provided in the STS client configuration in the admin console.
  - getAddress
```
public String getAddress()
```
    Description copied from interface: STSClientConfiguration
    
    Retrieves the address of the STS server.
    
    Specified by:
    
    getAddress in interface STSClientConfiguration
    
    Returns:
    
    String-based URL of the STS endpoint with no "WSDL" on the end.
  - setAddress
```
public void setAddress(String address)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the address of the STS server.
    
    Specified by:
    
    setAddress in interface STSClientConfiguration
    
    Parameters:
    
    address - String-based URL of the STS endpoint with no "WSDL" on the end.
  - getEndpointName
```
public String getEndpointName()
```
    Description copied from interface: STSClientConfiguration
    
    Retrieves the endpoint name of the STS service.
    Default is {http://docs.oasis-open.org/ws-sx/ws-trust/200512/}STS_Port
    
    Specified by:
    
    getEndpointName in interface STSClientConfiguration
    
    Returns:
    
    String-based endpoint name
  - setEndpointName
```
public void setEndpointName(String endpointName)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the endpoint name of the STS service.
    
    Specified by:
    
    setEndpointName in interface STSClientConfiguration
    
    Parameters:
    
    endpointName - String-based endpoint name.
  - getServiceName
```
public String getServiceName()
```
    Description copied from interface: STSClientConfiguration
    
    Retrieves the service name of the STS service.
    Default is {http://docs.oasis-open.org/ws-sx/ws-trust/200512/} SecurityTokenService
    
    Specified by:
    
    getServiceName in interface STSClientConfiguration
    
    Returns:
    
    String-based service name
  - setServiceName
```
public void setServiceName(String serviceName)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the service name of the STS service.
    
    Specified by:
    
    setServiceName in interface STSClientConfiguration
    
    Parameters:
    
    serviceName - String-based service name
  - getUsername
```
public String getUsername()
```
    Description copied from interface: STSClientConfiguration
    
    Retrieves the user's name for performing operations on the STS.
    
    Specified by:
    
    getUsername in interface STSClientConfiguration
    
    Returns:
    
    username
  - setUsername
```
public void setUsername(String username)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the user's name to use for performing STS operations.
    
    Specified by:
    
    setUsername in interface STSClientConfiguration
  - getPassword
```
public String getPassword()
```
    Description copied from interface: STSClientConfiguration
    
    Retrieves the password for the associated username set in #setUsername()
    
    Specified by:
    
    getPassword in interface STSClientConfiguration
    
    Returns:
    
    password
  - setPassword
```
public void setPassword(String password)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the password for the current user.
    
    Specified by:
    
    setPassword in interface STSClientConfiguration
  - getSignatureUsername
```
public String getSignatureUsername()
```
    Description copied from interface: STSClientConfiguration
    
    Per WS-Security Policy:
    The user's name for signature. It is used as the alias name in the keystore to get the user's cert and private key for signature.
    
    Specified by:
    
    getSignatureUsername in interface STSClientConfiguration
    
    Returns:
    
    username
  - setSignatureUsername
```
public void setSignatureUsername(String signatureUsername)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the user's signature name.
    
    Specified by:
    
    setSignatureUsername in interface STSClientConfiguration
  - getSignatureProperties
```
public String getSignatureProperties()
```
    Description copied from interface: STSClientConfiguration
    
    Per WS-Security Policy:
    Location of the crypto property configuration to use for signature.
    
    Specified by:
    
    getSignatureProperties in interface STSClientConfiguration
    
    Returns:
    
    Location of the property file.
  - setSignatureProperties
```
public void setSignatureProperties(String signatureProperties)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the location of the signature properties file.
    
    Specified by:
    
    setSignatureProperties in interface STSClientConfiguration
  - getEncryptionUsername
```
public String getEncryptionUsername()
```
    Description copied from interface: STSClientConfiguration
    
    Per WS-Security Policy:
    The user's name for encryption. It is used as the alias name in the keystore to get the user's public key for encryption.
    
    Specified by:
    
    getEncryptionUsername in interface STSClientConfiguration
    
    Returns:
    
    user's name for encryption.
  - setEncryptionUsername
```
public void setEncryptionUsername(String encryptionUsername)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the user's name for encryption.
    
    Specified by:
    
    setEncryptionUsername in interface STSClientConfiguration
  - getEncryptionProperties
```
public String getEncryptionProperties()
```
    Description copied from interface: STSClientConfiguration
    
    Per WS-Security Policy:
    Location of the crypto property configuration to use for encryption.
    
    Specified by:
    
    getEncryptionProperties in interface STSClientConfiguration
    
    Returns:
    
    Location of the property file.
  - setEncryptionProperties
```
public void setEncryptionProperties(String encryptionProperties)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the location of the encryption properties file.
    
    Specified by:
    
    setEncryptionProperties in interface STSClientConfiguration
  - getTokenUsername
```
public String getTokenUsername()
```
    Description copied from interface: STSClientConfiguration
    
    Per WS-Security Policy:
    The alias name in the keystore to get the user's public key to send to the STS for the PublicKey KeyType case.
    
    Specified by:
    
    getTokenUsername in interface STSClientConfiguration
    
    Returns:
    
    user's name for the publickey.
  - setTokenUsername
```
public void setTokenUsername(String tokenUsername)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the alias name for the user's public key.
    
    Specified by:
    
    setTokenUsername in interface STSClientConfiguration
  - getTokenProperties
```
public String getTokenProperties()
```
    Description copied from interface: STSClientConfiguration
    
    Per WS-Security Policy:
    Location of the crypto property configuration used by the STSClient to send/process any RSA/DSAKeyValue tokens used if the KeyType is "PublicKey".
    
    Specified by:
    
    getTokenProperties in interface STSClientConfiguration
    
    Returns:
    
    Location of the property file.
  - setTokenProperties
```
public void setTokenProperties(String tokenProperties)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the location of the token properties file.
    
    Specified by:
    
    setTokenProperties in interface STSClientConfiguration
  - getClaims
```
public List<String> getClaims()
```
    Description copied from interface: STSClientConfiguration
    
    Retrieves the list of claims that should be requested from the STS.
    
    Specified by:
    
    getClaims in interface STSClientConfiguration
    
    Returns:
    
    List of string-based claim URIs.
  - setClaims
```
public void setClaims(List<String> claims)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the claim list with the incoming list.
    
    Specified by:
    
    setClaims in interface STSClientConfiguration
  - setClaims
```
public void setClaims(String claimsListAsString)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the claim list with the incoming comma-delimieted string of URI values.
    
    Specified by:
    
    setClaims in interface STSClientConfiguration
  - getAssertionType
```
public String getAssertionType()
```
    Description copied from interface: STSClientConfiguration
    
    Retrieves the assertion type that should be requested from the STS. Default value: http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV2.0
    
    Specified by:
    
    getAssertionType in interface STSClientConfiguration
    
    Returns:
    
    assertion type
  - setAssertionType
```
public void setAssertionType(String assertionType)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the assertion type that should be requested from the STS. Default value: http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV2.0
    
    Specified by:
    
    setAssertionType in interface STSClientConfiguration
  - getKeyType
```
public String getKeyType()
```
    Description copied from interface: STSClientConfiguration
    
    Retrieves the key type that should be used when communicating with the STS. Default value: http://docs.oasis-open.org/ws-sx/ws-trust/200512/PublicKey
    
    Specified by:
    
    getKeyType in interface STSClientConfiguration
    
    Returns:
    
    key type
  - setKeyType
```
public void setKeyType(String keyType)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the key type that should be used when communicating with the STS. Default value: http://docs.oasis-open.org/ws-sx/ws-trust/200512/PublicKey
    
    Specified by:
    
    setKeyType in interface STSClientConfiguration
  - getKeySize
```
public String getKeySize()
```
    Description copied from interface: STSClientConfiguration
    
    Retrieves the size of the key that should be used. Default value: 256
    
    Specified by:
    
    getKeySize in interface STSClientConfiguration
    
    Returns:
    
    key size
  - setKeySize
```
public void setKeySize(String keySize)
```
    Description copied from interface: STSClientConfiguration
    
    Sets the size of the key that should be used. Default value: 256
    
    Specified by:
    
    setKeySize in interface STSClientConfiguration
  - getUseKey
```
public Boolean getUseKey()
```
    Description copied from interface: STSClientConfiguration
    
    Flags whether or not to supply a key in the request. Default value: true
    
    Specified by:
    
    getUseKey in interface STSClientConfiguration
    
    Returns:
    
    true to supply a key
  - setUseKey
```
public void setUseKey(Boolean useKey)
```
    Description copied from interface: STSClientConfiguration
    
    Sets whether or not to supply a key in the request. Default value: true
    
    Specified by:
    
    setUseKey in interface STSClientConfiguration

Class AbstractStsRealm

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.shiro.realm.AuthenticatingRealm

Methods inherited from class org.apache.shiro.realm.CachingRealm

Methods inherited from class java.lang.Object

Field Detail

bus

Constructor Detail

AbstractStsRealm

Method Detail

getContextPolicyManager

setContextPolicyManager

supports

shouldHandleWss

doGetAuthenticationInfo

requestSecurityToken

renewSecurityToken

getBus

configureStsClient

createClaimsElement

getAddress

setAddress

getEndpointName

setEndpointName

getServiceName

setServiceName

getUsername

setUsername

getPassword

setPassword

getSignatureUsername

setSignatureUsername

getSignatureProperties

setSignatureProperties

getEncryptionUsername

setEncryptionUsername

getEncryptionProperties

setEncryptionProperties

getTokenUsername

setTokenUsername

getTokenProperties

setTokenProperties

getClaims

setClaims

setClaims

getAssertionType

setAssertionType

getKeyType

setKeyType

getKeySize

setKeySize

getUseKey

setUseKey