StaticSTSProperties (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.sts.StaticSTSProperties

All Implemented Interfaces:

STSPropertiesMBean
```
public class StaticSTSProperties
extends Object
implements STSPropertiesMBean
```
A static implementation of the STSPropertiesMBean.

Constructor Summary

Constructors
Constructor and Description

StaticSTSProperties()

Constructors
Constructor and Description
`StaticSTSProperties()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`configureProperties()` Load the CallbackHandler, Crypto objects, if necessary.
`Bus`	`getBus()`
`CallbackHandler`	`getCallbackHandler()` Get the CallbackHandler object.
`org.apache.wss4j.common.crypto.Crypto`	`getEncryptionCrypto()` Get the encryption Crypto object
`EncryptionProperties`	`getEncryptionProperties()` Get the EncryptionProperties to use.
`String`	`getEncryptionUsername()` Get the username/alias to use to encrypt any issued tokens.
`IdentityMapper`	`getIdentityMapper()` Get the IdentityMapper object to use.
`String`	`getIssuer()` Get the STS issuer name
`RealmParser`	`getRealmParser()` Get the RealmParser object to use.
`RelationshipResolver`	`getRelationshipResolver()` Get the RelationshipResolver objects to use.
`List<Relationship>`	`getRelationships()` Get the list of Relationship objects to use.
`SAMLRealmCodec`	`getSamlRealmCodec()` Get the SAML Realm Codec object to use.
`org.apache.wss4j.common.crypto.Crypto`	`getSignatureCrypto()` Get the signature Crypto object
`SignatureProperties`	`getSignatureProperties()` Get the SignatureProperties to use.
`String`	`getSignatureUsername()` Get the username/alias to use to sign any issued tokens
`boolean`	`isValidateUseKey()` Get whether to validate a client Public Key or Certificate presented as part of a UseKey element.
`void`	`setBus(Bus bus)`
`void`	`setCallbackHandler(CallbackHandler callbackHandler)` Set the CallbackHandler object.
`void`	`setCallbackHandlerClass(String callbackHandlerClass)` Set the String corresponding to the CallbackHandler class.
`void`	`setEncryptionCrypto(org.apache.wss4j.common.crypto.Crypto encryptionCrypto)` Set the encryption Crypto object
`void`	`setEncryptionCryptoProperties(Object encryptionCryptoProperties)` Set the Object corresponding to the encryption Properties class.
`void`	`setEncryptionProperties(EncryptionProperties encryptionProperties)` Set the EncryptionProperties to use.
`void`	`setEncryptionPropertiesFile(String encryptionPropertiesFile)` Deprecated.
`void`	`setEncryptionUsername(String encryptionUsername)` Set the username/alias to use to encrypt any issued tokens.
`void`	`setIdentityMapper(IdentityMapper identityMapper)` Set the IdentityMapper object to use.
`void`	`setIssuer(String issuer)` Set the STS issuer name
`void`	`setRealmParser(RealmParser realmParser)` Set the RealmParser object to use.
`void`	`setRelationships(List<Relationship> relationships)` Set the list of Relationship objects to use.
`void`	`setSamlRealmCodec(SAMLRealmCodec samlRealmCodec)` Set the SAML Realm Codec object to use.
`void`	`setSignatureCrypto(org.apache.wss4j.common.crypto.Crypto signatureCrypto)` Set the signature Crypto object
`void`	`setSignatureCryptoProperties(Object signatureCryptoProperties)` Set the Object corresponding to the signature Properties class.
`void`	`setSignatureProperties(SignatureProperties signatureProperties)` Set the SignatureProperties to use.
`void`	`setSignaturePropertiesFile(String signaturePropertiesFile)` Deprecated.
`void`	`setSignatureUsername(String signatureUsername)` Set the username/alias to use to sign any issued tokens
`void`	`setValidateUseKey(boolean validateUseKey)` Set whether to validate a client Public Key or Certificate presented as part of a UseKey element.

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

- Constructor Detail
  - StaticSTSProperties
```
public StaticSTSProperties()
```
- Method Detail
  - configureProperties
```
public void configureProperties()
                         throws STSException
```
    Load the CallbackHandler, Crypto objects, if necessary.
    
    Specified by:
    
    configureProperties in interface STSPropertiesMBean
    
    Throws:
    
    STSException
  - setCallbackHandler
```
public void setCallbackHandler(CallbackHandler callbackHandler)
```
    Set the CallbackHandler object.
    
    Specified by:
    
    setCallbackHandler in interface STSPropertiesMBean
    
    Parameters:
    callbackHandler - the CallbackHandler object.
  - setCallbackHandlerClass
```
public void setCallbackHandlerClass(String callbackHandlerClass)
```
    Set the String corresponding to the CallbackHandler class.
    
    Parameters:
    callbackHandlerClass - the String corresponding to the CallbackHandler class.
  - getCallbackHandler
```
public CallbackHandler getCallbackHandler()
```
    Get the CallbackHandler object.
    
    Specified by:
    
    getCallbackHandler in interface STSPropertiesMBean
    
    Returns:
    the CallbackHandler object.
  - setSignatureCrypto
```
public void setSignatureCrypto(org.apache.wss4j.common.crypto.Crypto signatureCrypto)
```
    Set the signature Crypto object
    
    Specified by:
    
    setSignatureCrypto in interface STSPropertiesMBean
    
    Parameters:
    signatureCrypto - the signature Crypto object
  - setSignaturePropertiesFile
```
@Deprecated
public void setSignaturePropertiesFile(String signaturePropertiesFile)
```
    Deprecated.
    
    Set the String corresponding to the signature Properties class
    
    Parameters:
    signaturePropertiesFile - the String corresponding to the signature properties file
  - setSignatureCryptoProperties
```
public void setSignatureCryptoProperties(Object signatureCryptoProperties)
```
    Set the Object corresponding to the signature Properties class. It can be a String corresponding to a filename, a Properties object, or a URL.
    
    Parameters:
    signatureCryptoProperties - the object corresponding to the signature properties
  - getSignatureCrypto
```
public org.apache.wss4j.common.crypto.Crypto getSignatureCrypto()
```
    Get the signature Crypto object
    
    Specified by:
    
    getSignatureCrypto in interface STSPropertiesMBean
    
    Returns:
    the signature Crypto object
  - setSignatureUsername
```
public void setSignatureUsername(String signatureUsername)
```
    Set the username/alias to use to sign any issued tokens
    
    Specified by:
    
    setSignatureUsername in interface STSPropertiesMBean
    
    Parameters:
    signatureUsername - the username/alias to use to sign any issued tokens
  - getSignatureUsername
```
public String getSignatureUsername()
```
    Get the username/alias to use to sign any issued tokens
    
    Specified by:
    
    getSignatureUsername in interface STSPropertiesMBean
    
    Returns:
    the username/alias to use to sign any issued tokens
  - setEncryptionCrypto
```
public void setEncryptionCrypto(org.apache.wss4j.common.crypto.Crypto encryptionCrypto)
```
    Set the encryption Crypto object
    
    Specified by:
    
    setEncryptionCrypto in interface STSPropertiesMBean
    
    Parameters:
    encryptionCrypto - the encryption Crypto object
  - setEncryptionPropertiesFile
```
@Deprecated
public void setEncryptionPropertiesFile(String encryptionPropertiesFile)
```
    Deprecated.
    
    Set the String corresponding to the encryption Properties class
    
    Parameters:
    signaturePropertiesFile - the String corresponding to the encryption properties file
  - setEncryptionCryptoProperties
```
public void setEncryptionCryptoProperties(Object encryptionCryptoProperties)
```
    Set the Object corresponding to the encryption Properties class. It can be a String corresponding to a filename, a Properties object, or a URL.
    
    Parameters:
    encryptionCryptoProperties - the object corresponding to the encryption properties
  - getEncryptionCrypto
```
public org.apache.wss4j.common.crypto.Crypto getEncryptionCrypto()
```
    Get the encryption Crypto object
    
    Specified by:
    
    getEncryptionCrypto in interface STSPropertiesMBean
    
    Returns:
    the encryption Crypto object
  - setEncryptionUsername
```
public void setEncryptionUsername(String encryptionUsername)
```
    Set the username/alias to use to encrypt any issued tokens. This is a default value - it can be configured per Service in the ServiceMBean.
    
    Specified by:
    
    setEncryptionUsername in interface STSPropertiesMBean
    
    Parameters:
    encryptionUsername - the username/alias to use to encrypt any issued tokens
  - getEncryptionUsername
```
public String getEncryptionUsername()
```
    Get the username/alias to use to encrypt any issued tokens. This is a default value - it can be configured per Service in the ServiceMBean
    
    Specified by:
    
    getEncryptionUsername in interface STSPropertiesMBean
    
    Returns:
    the username/alias to use to encrypt any issued tokens
  - setEncryptionProperties
```
public void setEncryptionProperties(EncryptionProperties encryptionProperties)
```
    Set the EncryptionProperties to use.
    
    Specified by:
    
    setEncryptionProperties in interface STSPropertiesMBean
    
    Parameters:
    encryptionProperties - the EncryptionProperties to use.
  - getEncryptionProperties
```
public EncryptionProperties getEncryptionProperties()
```
    Get the EncryptionProperties to use.
    
    Specified by:
    
    getEncryptionProperties in interface STSPropertiesMBean
    
    Returns:
    the EncryptionProperties to use.
  - setIssuer
```
public void setIssuer(String issuer)
```
    Set the STS issuer name
    
    Specified by:
    
    setIssuer in interface STSPropertiesMBean
    
    Parameters:
    issuer - the STS issuer name
  - getIssuer
```
public String getIssuer()
```
    Get the STS issuer name
    
    Specified by:
    
    getIssuer in interface STSPropertiesMBean
    
    Returns:
    the STS issuer name
  - setSignatureProperties
```
public void setSignatureProperties(SignatureProperties signatureProperties)
```
    Set the SignatureProperties to use.
    
    Specified by:
    
    setSignatureProperties in interface STSPropertiesMBean
    
    Parameters:
    signatureProperties - the SignatureProperties to use.
  - getSignatureProperties
```
public SignatureProperties getSignatureProperties()
```
    Get the SignatureProperties to use.
    
    Specified by:
    
    getSignatureProperties in interface STSPropertiesMBean
    
    Returns:
    the SignatureProperties to use.
  - setRealmParser
```
public void setRealmParser(RealmParser realmParser)
```
    Set the RealmParser object to use.
    
    Specified by:
    
    setRealmParser in interface STSPropertiesMBean
    
    Parameters:
    realmParser - the RealmParser object to use.
  - getRealmParser
```
public RealmParser getRealmParser()
```
    Get the RealmParser object to use.
    
    Specified by:
    
    getRealmParser in interface STSPropertiesMBean
    
    Returns:
    the RealmParser object to use.
  - setIdentityMapper
```
public void setIdentityMapper(IdentityMapper identityMapper)
```
    Set the IdentityMapper object to use.
    
    Specified by:
    
    setIdentityMapper in interface STSPropertiesMBean
    
    Parameters:
    identityMapper - the IdentityMapper object to use.
  - getIdentityMapper
```
public IdentityMapper getIdentityMapper()
```
    Get the IdentityMapper object to use.
    
    Specified by:
    
    getIdentityMapper in interface STSPropertiesMBean
    
    Returns:
    the IdentityMapper object to use.
  - setRelationships
```
public void setRelationships(List<Relationship> relationships)
```
    Description copied from interface: STSPropertiesMBean
    
    Set the list of Relationship objects to use.
    
    Specified by:
    
    setRelationships in interface STSPropertiesMBean
    
    Parameters:
    relationships - the List object to use.
  - getRelationships
```
public List<Relationship> getRelationships()
```
    Description copied from interface: STSPropertiesMBean
    
    Get the list of Relationship objects to use.
    
    Specified by:
    
    getRelationships in interface STSPropertiesMBean
    
    Returns:
    the List object to use.
  - getRelationshipResolver
```
public RelationshipResolver getRelationshipResolver()
```
    Description copied from interface: STSPropertiesMBean
    
    Get the RelationshipResolver objects to use.
    
    Specified by:
    
    getRelationshipResolver in interface STSPropertiesMBean
    
    Returns:
    the RelationshipResolver object to use.
  - getSamlRealmCodec
```
public SAMLRealmCodec getSamlRealmCodec()
```
    Description copied from interface: STSPropertiesMBean
    
    Get the SAML Realm Codec object to use.
    
    Specified by:
    
    getSamlRealmCodec in interface STSPropertiesMBean
    
    Returns:
    the SAMLRealmCodec object to use.
  - setSamlRealmCodec
```
public void setSamlRealmCodec(SAMLRealmCodec samlRealmCodec)
```
    Description copied from interface: STSPropertiesMBean
    
    Set the SAML Realm Codec object to use.
    
    Specified by:
    
    setSamlRealmCodec in interface STSPropertiesMBean
    
    Parameters:
    samlRealmCodec - the SAMLRealmCodec object to use.
  - getBus
```
public Bus getBus()
```
  - setBus
```
public void setBus(Bus bus)
```
  - isValidateUseKey
```
public boolean isValidateUseKey()
```
    Get whether to validate a client Public Key or Certificate presented as part of a UseKey element. This is true by default.
    
    Specified by:
    
    isValidateUseKey in interface STSPropertiesMBean
  - setValidateUseKey
```
public void setValidateUseKey(boolean validateUseKey)
```
    Set whether to validate a client Public Key or Certificate presented as part of a UseKey element. If this is set to true (the default), the public key must be trusted by the Signature Crypto of the STS.
    
    Specified by:
    
    setValidateUseKey in interface STSPropertiesMBean
    
    Parameters:
    validateUseKey - whether to validate a client UseKey or not.

Class StaticSTSProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StaticSTSProperties

Method Detail

configureProperties

setCallbackHandler

setCallbackHandlerClass

getCallbackHandler

setSignatureCrypto

setSignaturePropertiesFile

setSignatureCryptoProperties

getSignatureCrypto

setSignatureUsername

getSignatureUsername

setEncryptionCrypto

setEncryptionPropertiesFile

setEncryptionCryptoProperties

getEncryptionCrypto

setEncryptionUsername

getEncryptionUsername

setEncryptionProperties

getEncryptionProperties

setIssuer

getIssuer

setSignatureProperties

getSignatureProperties

setRealmParser

getRealmParser

setIdentityMapper

getIdentityMapper

setRelationships

getRelationships

getRelationshipResolver

getSamlRealmCodec

setSamlRealmCodec

getBus

setBus

isValidateUseKey

setValidateUseKey