STSPropertiesMBean (Apache CXF JavaDoc 3.1.0 API)

All Known Implementing Classes:

StaticSTSProperties
```
public interface STSPropertiesMBean
```
This MBean represents the properties associated with the STS. It contains a single operation "configureProperties()" which allows subclasses to perform any custom loading/processing of the properties.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`configureProperties()` Load/process the CallbackHandler, Crypto objects, etc.
`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`	`setCallbackHandler(CallbackHandler callbackHandler)` Set the CallbackHandler object.
`void`	`setEncryptionCrypto(org.apache.wss4j.common.crypto.Crypto encryptionCrypto)` Set the encryption Crypto object
`void`	`setEncryptionProperties(EncryptionProperties encryptionProperties)` Set the EncryptionProperties to use.
`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`	`setSignatureProperties(SignatureProperties signatureProperties)` Set the SignatureProperties to use.
`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.

- Method Detail
  - configureProperties
```
void configureProperties()
                         throws STSException
```
    Load/process the CallbackHandler, Crypto objects, etc.
    
    Throws:
    
    STSException
  - setCallbackHandler
```
void setCallbackHandler(CallbackHandler callbackHandler)
```
    Set the CallbackHandler object.
    
    Parameters:
    callbackHandler - the CallbackHandler object.
  - getCallbackHandler
```
CallbackHandler getCallbackHandler()
```
    Get the CallbackHandler object.
    
    Returns:
    the CallbackHandler object.
  - setSignatureCrypto
```
void setSignatureCrypto(org.apache.wss4j.common.crypto.Crypto signatureCrypto)
```
    Set the signature Crypto object
    
    Parameters:
    signatureCrypto - the signature Crypto object
  - getSignatureCrypto
```
org.apache.wss4j.common.crypto.Crypto getSignatureCrypto()
```
    Get the signature Crypto object
    
    Returns:
    the signature Crypto object
  - setSignatureUsername
```
void setSignatureUsername(String signatureUsername)
```
    Set the username/alias to use to sign any issued tokens
    
    Parameters:
    signatureUsername - the username/alias to use to sign any issued tokens
  - getSignatureUsername
```
String getSignatureUsername()
```
    Get the username/alias to use to sign any issued tokens
    
    Returns:
    the username/alias to use to sign any issued tokens
  - setEncryptionCrypto
```
void setEncryptionCrypto(org.apache.wss4j.common.crypto.Crypto encryptionCrypto)
```
    Set the encryption Crypto object
    
    Parameters:
    encryptionCrypto - the encryption Crypto object
  - getEncryptionCrypto
```
org.apache.wss4j.common.crypto.Crypto getEncryptionCrypto()
```
    Get the encryption Crypto object
    
    Returns:
    the encryption Crypto object
  - setEncryptionUsername
```
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.
    
    Parameters:
    encryptionUsername - the username/alias to use to encrypt any issued tokens
  - getEncryptionUsername
```
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
    
    Returns:
    the username/alias to use to encrypt any issued tokens
  - setEncryptionProperties
```
void setEncryptionProperties(EncryptionProperties encryptionProperties)
```
    Set the EncryptionProperties to use.
    
    Parameters:
    encryptionProperties - the EncryptionProperties to use.
  - getEncryptionProperties
```
EncryptionProperties getEncryptionProperties()
```
    Get the EncryptionProperties to use.
    
    Returns:
    the EncryptionProperties to use.
  - setIssuer
```
void setIssuer(String issuer)
```
    Set the STS issuer name
    
    Parameters:
    issuer - the STS issuer name
  - getIssuer
```
String getIssuer()
```
    Get the STS issuer name
    
    Returns:
    the STS issuer name
  - setSignatureProperties
```
void setSignatureProperties(SignatureProperties signatureProperties)
```
    Set the SignatureProperties to use.
    
    Parameters:
    signatureProperties - the SignatureProperties to use.
  - getSignatureProperties
```
SignatureProperties getSignatureProperties()
```
    Get the SignatureProperties to use.
    
    Returns:
    the SignatureProperties to use.
  - setRealmParser
```
void setRealmParser(RealmParser realmParser)
```
    Set the RealmParser object to use.
    
    Parameters:
    realmParser - the RealmParser object to use.
  - getRealmParser
```
RealmParser getRealmParser()
```
    Get the RealmParser object to use.
    
    Returns:
    the RealmParser object to use.
  - setIdentityMapper
```
void setIdentityMapper(IdentityMapper identityMapper)
```
    Set the IdentityMapper object to use.
    
    Parameters:
    identityMapper - the IdentityMapper object to use.
  - getIdentityMapper
```
IdentityMapper getIdentityMapper()
```
    Get the IdentityMapper object to use.
    
    Returns:
    the IdentityMapper object to use.
  - setRelationships
```
void setRelationships(List<Relationship> relationships)
```
    Set the list of Relationship objects to use.
    
    Parameters:
    relationships - the List object to use.
  - getRelationships
```
List<Relationship> getRelationships()
```
    Get the list of Relationship objects to use.
    
    Returns:
    the List object to use.
  - getRelationshipResolver
```
RelationshipResolver getRelationshipResolver()
```
    Get the RelationshipResolver objects to use.
    
    Returns:
    the RelationshipResolver object to use.
  - getSamlRealmCodec
```
SAMLRealmCodec getSamlRealmCodec()
```
    Get the SAML Realm Codec object to use.
    
    Returns:
    the SAMLRealmCodec object to use.
  - setSamlRealmCodec
```
void setSamlRealmCodec(SAMLRealmCodec samlRealmCodec)
```
    Set the SAML Realm Codec object to use.
    
    Parameters:
    samlRealmCodec - the SAMLRealmCodec object to use.
  - isValidateUseKey
```
boolean isValidateUseKey()
```
    Get whether to validate a client Public Key or Certificate presented as part of a UseKey element. This is true by default.
  - setValidateUseKey
```
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.
    
    Parameters:
    validateUseKey - whether to validate a client UseKey or not.

Interface STSPropertiesMBean

Method Summary

Method Detail

configureProperties

setCallbackHandler

getCallbackHandler

setSignatureCrypto

getSignatureCrypto

setSignatureUsername

getSignatureUsername

setEncryptionCrypto

getEncryptionCrypto

setEncryptionUsername

getEncryptionUsername

setEncryptionProperties

getEncryptionProperties

setIssuer

getIssuer

setSignatureProperties

getSignatureProperties

setRealmParser

getRealmParser

setIdentityMapper

getIdentityMapper

setRelationships

getRelationships

getRelationshipResolver

getSamlRealmCodec

setSamlRealmCodec

isValidateUseKey

setValidateUseKey