org.apache.rampart.policy.model
Class RampartConfig

java.lang.Object
  extended by org.apache.rampart.policy.model.RampartConfig
All Implemented Interfaces:
org.apache.neethi.Assertion, org.apache.neethi.PolicyComponent

public class RampartConfig
extends java.lang.Object
implements org.apache.neethi.Assertion

Rampart policy model bean to capture Rampart configuration assertion info. Example:

  <ramp:RampartConfig xmlns:ramp="http://ws.apache.org/rampart/policy"> 
  <ramp:user>alice</ramp:user>
  <ramp:encryptionUser>bob</ramp:encryptionUser>
  <ramp:passwordCallbackClass>org.apache.axis2.security.PWCallback</ramp:passwordCallbackClass>
  <ramp:policyValidatorCbClass>org.apache.axis2.security.ramp:PolicyValidatorCallbackHandler</ramp:policyValidatorCbClass>
  <ramp:timestampPrecisionInMilliseconds>true</timestampPrecisionInMilliseconds>
  <ramp:timestampTTL>300</ramp:timestampTTL>
  <ramp:timestampMaxSkew>0</ramp:timestampMaxSkew>
  <ramp:tokenStoreClass>org.apache.rahas.StorageImpl</ramp:tokenStoreClass>
  
  <ramp:signatureCrypto>
  <ramp:crypto provider="org.apache.ws.security.components.crypto.Merlin">
  <ramp:property name="keystoreType">JKS</ramp:property>
  <ramp:property name="keystoreFile">/path/to/file.jks</ramp:property>
  <ramp:property name="keystorePassword">password</ramp:property>
  </ramp:crypto>
  </ramp:signatureCrypto>
  
  <ramp:tokenIssuerPolicy>
  <wsp:Policy>
  ....
  ....
  </wsp:Policy>
  </ramp:tokenIssuerPolicy>
  </ramp:RampartConfig>
 
 


Field Summary
static java.lang.String DEC_CRYPTO_LN
           
static int DEFAULT_TIMESTAMP_MAX_SKEW
           
static boolean DEFAULT_TIMESTAMP_PRECISION_IN_MS
           
static int DEFAULT_TIMESTAMP_TTL
           
static java.lang.String ENCR_CRYPTO_LN
           
static java.lang.String ENCRYPTION_USER_LN
           
static java.lang.String NS
           
static java.lang.String OPTIMISE_PARTS
           
static java.lang.String POLICY_VALIDATOR_CB_CLASS_LN
           
static java.lang.String PREFIX
           
static java.lang.String PW_CB_CLASS_LN
           
static java.lang.String RAMPART_CONFIG_LN
           
static java.lang.String SIG_CRYPTO_LN
           
static java.lang.String SSL_CONFIG
           
static java.lang.String STS_ALIAS_LN
           
static java.lang.String STS_CRYPTO_LN
           
static java.lang.String TOKEN_STORE_CLASS_LN
           
static java.lang.String TS_MAX_SKEW_LN
           
static java.lang.String TS_PRECISION_IN_MS_LN
           
static java.lang.String TS_TTL_LN
           
static java.lang.String USER_CERT_ALIAS_LN
           
static java.lang.String USER_LN
           
 
Constructor Summary
RampartConfig()
           
 
Method Summary
 boolean equal(org.apache.neethi.PolicyComponent policyComponent)
           
 CryptoConfig getDecCryptoConfig()
           
 CryptoConfig getEncrCryptoConfig()
           
 java.lang.String getEncryptionUser()
           
 javax.xml.namespace.QName getName()
           
 OptimizePartsConfig getOptimizeParts()
           
 java.lang.String getPolicyValidatorCbClass()
           
 java.lang.String getPwCbClass()
           
 CryptoConfig getSigCryptoConfig()
           
 SSLConfig getSSLConfig()
           
 java.lang.String getStsAlias()
           
 CryptoConfig getStsCryptoConfig()
           
 java.lang.String getTimestampMaxSkew()
           
 java.lang.String getTimestampPrecisionInMilliseconds()
           
 java.lang.String getTimestampTTL()
           
 java.lang.String getTokenStoreClass()
           
 short getType()
           
 java.lang.String getUser()
           
 java.lang.String getUserCertAlias()
           
 boolean isOptional()
           
 org.apache.neethi.PolicyComponent normalize()
           
 void serialize(javax.xml.stream.XMLStreamWriter writer)
           
 void setDecCryptoConfig(CryptoConfig decCrypto)
           
 void setEncrCryptoConfig(CryptoConfig encrCrypto)
           
 void setEncryptionUser(java.lang.String encryptionUser)
           
 void setOptimizeParts(OptimizePartsConfig optimizeParts)
           
 void setPolicyValidatorCbClass(java.lang.String policyValidatorCbClass)
           
 void setPwCbClass(java.lang.String pwCbClass)
           
 void setSigCryptoConfig(CryptoConfig sigCryptoConfig)
           
 void setSSLConfig(SSLConfig sslConfig)
           
 void setStsAlias(java.lang.String stsAlias)
           
 void setStsCryptoConfig(CryptoConfig stsCryptoConfig)
           
 void setTimestampMaxSkew(java.lang.String timestampMaxSkew)
           
 void setTimestampPrecisionInMilliseconds(java.lang.String timestampPrecisionInMilliseconds)
           
 void setTimestampTTL(java.lang.String timestampTTL)
           
 void setTokenStoreClass(java.lang.String tokenStoreClass)
           
 void setUser(java.lang.String user)
           
 void setUserCertAlias(java.lang.String userCertAlias)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_TIMESTAMP_PRECISION_IN_MS

public static final boolean DEFAULT_TIMESTAMP_PRECISION_IN_MS
See Also:
Constant Field Values

DEFAULT_TIMESTAMP_TTL

public static final int DEFAULT_TIMESTAMP_TTL
See Also:
Constant Field Values

DEFAULT_TIMESTAMP_MAX_SKEW

public static final int DEFAULT_TIMESTAMP_MAX_SKEW
See Also:
Constant Field Values

NS

public static final java.lang.String NS
See Also:
Constant Field Values

PREFIX

public static final java.lang.String PREFIX
See Also:
Constant Field Values

RAMPART_CONFIG_LN

public static final java.lang.String RAMPART_CONFIG_LN
See Also:
Constant Field Values

USER_LN

public static final java.lang.String USER_LN
See Also:
Constant Field Values

USER_CERT_ALIAS_LN

public static final java.lang.String USER_CERT_ALIAS_LN
See Also:
Constant Field Values

ENCRYPTION_USER_LN

public static final java.lang.String ENCRYPTION_USER_LN
See Also:
Constant Field Values

STS_ALIAS_LN

public static final java.lang.String STS_ALIAS_LN
See Also:
Constant Field Values

PW_CB_CLASS_LN

public static final java.lang.String PW_CB_CLASS_LN
See Also:
Constant Field Values

POLICY_VALIDATOR_CB_CLASS_LN

public static final java.lang.String POLICY_VALIDATOR_CB_CLASS_LN
See Also:
Constant Field Values

SIG_CRYPTO_LN

public static final java.lang.String SIG_CRYPTO_LN
See Also:
Constant Field Values

ENCR_CRYPTO_LN

public static final java.lang.String ENCR_CRYPTO_LN
See Also:
Constant Field Values

DEC_CRYPTO_LN

public static final java.lang.String DEC_CRYPTO_LN
See Also:
Constant Field Values

STS_CRYPTO_LN

public static final java.lang.String STS_CRYPTO_LN
See Also:
Constant Field Values

TS_PRECISION_IN_MS_LN

public static final java.lang.String TS_PRECISION_IN_MS_LN
See Also:
Constant Field Values

TS_TTL_LN

public static final java.lang.String TS_TTL_LN
See Also:
Constant Field Values

TS_MAX_SKEW_LN

public static final java.lang.String TS_MAX_SKEW_LN
See Also:
Constant Field Values

TOKEN_STORE_CLASS_LN

public static final java.lang.String TOKEN_STORE_CLASS_LN
See Also:
Constant Field Values

OPTIMISE_PARTS

public static final java.lang.String OPTIMISE_PARTS
See Also:
Constant Field Values

SSL_CONFIG

public static final java.lang.String SSL_CONFIG
See Also:
Constant Field Values
Constructor Detail

RampartConfig

public RampartConfig()
Method Detail

getSSLConfig

public SSLConfig getSSLConfig()

setSSLConfig

public void setSSLConfig(SSLConfig sslConfig)

getTokenStoreClass

public java.lang.String getTokenStoreClass()
Returns:
Returns the tokenStoreClass.

setTokenStoreClass

public void setTokenStoreClass(java.lang.String tokenStoreClass)
Parameters:
tokenStoreClass - The tokenStoreClass to set.

getDecCryptoConfig

public CryptoConfig getDecCryptoConfig()

setDecCryptoConfig

public void setDecCryptoConfig(CryptoConfig decCrypto)

getEncrCryptoConfig

public CryptoConfig getEncrCryptoConfig()

setEncrCryptoConfig

public void setEncrCryptoConfig(CryptoConfig encrCrypto)

getEncryptionUser

public java.lang.String getEncryptionUser()

setEncryptionUser

public void setEncryptionUser(java.lang.String encryptionUser)

getPwCbClass

public java.lang.String getPwCbClass()

setPwCbClass

public void setPwCbClass(java.lang.String pwCbClass)

getPolicyValidatorCbClass

public java.lang.String getPolicyValidatorCbClass()

setPolicyValidatorCbClass

public void setPolicyValidatorCbClass(java.lang.String policyValidatorCbClass)

getSigCryptoConfig

public CryptoConfig getSigCryptoConfig()

setSigCryptoConfig

public void setSigCryptoConfig(CryptoConfig sigCryptoConfig)

getUser

public java.lang.String getUser()

setUser

public void setUser(java.lang.String user)

getUserCertAlias

public java.lang.String getUserCertAlias()

setUserCertAlias

public void setUserCertAlias(java.lang.String userCertAlias)

getName

public javax.xml.namespace.QName getName()
Specified by:
getName in interface org.apache.neethi.Assertion

isOptional

public boolean isOptional()
Specified by:
isOptional in interface org.apache.neethi.Assertion

normalize

public org.apache.neethi.PolicyComponent normalize()
Specified by:
normalize in interface org.apache.neethi.Assertion

serialize

public void serialize(javax.xml.stream.XMLStreamWriter writer)
               throws javax.xml.stream.XMLStreamException
Specified by:
serialize in interface org.apache.neethi.Assertion
Specified by:
serialize in interface org.apache.neethi.PolicyComponent
Throws:
javax.xml.stream.XMLStreamException

equal

public boolean equal(org.apache.neethi.PolicyComponent policyComponent)
Specified by:
equal in interface org.apache.neethi.PolicyComponent

getType

public short getType()
Specified by:
getType in interface org.apache.neethi.PolicyComponent

getTimestampPrecisionInMilliseconds

public java.lang.String getTimestampPrecisionInMilliseconds()

setTimestampPrecisionInMilliseconds

public void setTimestampPrecisionInMilliseconds(java.lang.String timestampPrecisionInMilliseconds)

getTimestampTTL

public java.lang.String getTimestampTTL()
Returns:
Returns the timestampTTL.

setTimestampTTL

public void setTimestampTTL(java.lang.String timestampTTL)
Parameters:
timestampTTL - The timestampTTL to set.

getTimestampMaxSkew

public java.lang.String getTimestampMaxSkew()
Returns:
Returns the timestampMaxSkew.

setTimestampMaxSkew

public void setTimestampMaxSkew(java.lang.String timestampMaxSkew)
Parameters:
timestampMaxSkew - The timestampMaxSkew to set.

getOptimizeParts

public OptimizePartsConfig getOptimizeParts()

setOptimizeParts

public void setOptimizeParts(OptimizePartsConfig optimizeParts)

getStsAlias

public java.lang.String getStsAlias()

setStsAlias

public void setStsAlias(java.lang.String stsAlias)

getStsCryptoConfig

public CryptoConfig getStsCryptoConfig()

setStsCryptoConfig

public void setStsCryptoConfig(CryptoConfig stsCryptoConfig)