IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.wssecurity.callbackhandler
Class X509ConsumeCallback

java.lang.Object
  extended by com.ibm.websphere.wssecurity.callbackhandler.X509ConsumeCallback
All Implemented Interfaces:
javax.security.auth.callback.Callback

public class X509ConsumeCallback
extends java.lang.Object
implements javax.security.auth.callback.Callback

This is a callback class for the X509 token in consumer side.

See Also:
X509Token, X509PKCS7Token, X509PKIPathToken, X509ConsumeCallbackHandler

Constructor Summary
X509ConsumeCallback()
           
 
Method Summary
 boolean existKeyStore()
          Returns whether the keystore used for keylocator exists or not.
 java.lang.String getAlias()
          Returns the alias name.
 java.security.cert.PKIXBuilderParameters getCertPathParameter()
          Returns the parameter used to check the path of X.509 certificates.
 java.util.List getCertStores()
          Returns the list of certificate stores.
 java.lang.String getKeyName()
          Returns the name of the key.
 char[] getKeyPassword()
          Returns the password for recovering the key.
 char[] getKeyStorePassword()
          Returns the type of the keystore used for key locator.
 java.lang.String getKeyStorePath()
          Returns the file path from which the keystore used for key locator is loaded.
 java.lang.String getKeyStoreReference()
          Returns the reference name of the keystore used for key locator.
 java.lang.String getKeyStoreType()
          Returns the type of the keystore used for key locator.
 java.security.Provider getProvider()
          Returns the security provider.
 char[] getTrustAnchorPassword()
          Returns the type of the trust anchor.
 java.lang.String getTrustAnchorPath()
          Returns the file path from which the trust anchor is loaded.
 java.lang.String getTrustAnchorType()
          Returns the type of the trust anchor.
 boolean isTrustAnyCertificate()
          Returns whether any certificate is trusted or not.
 void setAlias(java.lang.String alias)
          Sets the type of the keystore.
 void setCertPathParameter(java.security.cert.PKIXBuilderParameters certPathParam)
          Sets the parameter used to check the path of X.509 certificates.
 void setCertStores(java.util.List certStores)
          Sets the list of certificate stores.
 void setExistKeyStore(boolean existKeyStore)
          Sets whether the keystore used for keylocator exists or not.
 void setKeyName(java.lang.String keyName)
          Sets the name of the key.
 void setKeyPassword(char[] keyPassword)
          Sets the password for recovering the key.
 void setKeyStorePassword(char[] keyStorePassword)
          Sets the type of the keystore used for key locator.
 void setKeyStorePath(java.lang.String keyStorePath)
          Sets the file path from which the keystore used for key locator is loaded.
 void setKeyStoreReference(java.lang.String keyStoreRef)
          Sets the reference name of the keystore used for key locator.
 void setKeyStoreType(java.lang.String keyStoreType)
          Sets the type of the keystore used for key locator.
 void setProvider(java.security.Provider provider)
          Sets the security provider.
 void setTrustAnchorPassword(char[] trustAnchorPassword)
          Sets the type of the trust anchor.
 void setTrustAnchorPath(java.lang.String trustAnchorPath)
          Sets the file path from which the trust anchor is loaded.
 void setTrustAnchorType(java.lang.String trustAnchorType)
          Sets the type of the trust anchor.
 void setTrustAnyCertificate(boolean trustAnyCertificate)
          Sets whether any certificate is trusted or not.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

X509ConsumeCallback

public X509ConsumeCallback()
Method Detail

existKeyStore

public boolean existKeyStore()
Returns whether the keystore used for keylocator exists or not.

Returns:
true if the keystore configuration exists

setExistKeyStore

public void setExistKeyStore(boolean existKeyStore)
Sets whether the keystore used for keylocator exists or not.

Parameters:
existKeyStore - true if the keystore configuration exists

getKeyStoreReference

public java.lang.String getKeyStoreReference()
Returns the reference name of the keystore used for key locator.

Returns:
reference name of the keystore

setKeyStoreReference

public void setKeyStoreReference(java.lang.String keyStoreRef)
Sets the reference name of the keystore used for key locator.

Parameters:
keyStoreRef - reference name of the keystore

getKeyStorePath

public java.lang.String getKeyStorePath()
Returns the file path from which the keystore used for key locator is loaded.

Returns:
path of the keystore

setKeyStorePath

public void setKeyStorePath(java.lang.String keyStorePath)
Sets the file path from which the keystore used for key locator is loaded.

Parameters:
keyStorePath - path of the keystore

getKeyStoreType

public java.lang.String getKeyStoreType()
Returns the type of the keystore used for key locator.

Returns:
type of the keystore

setKeyStoreType

public void setKeyStoreType(java.lang.String keyStoreType)
Sets the type of the keystore used for key locator.

Parameters:
keyStoreType - type of the keystore

getKeyStorePassword

public char[] getKeyStorePassword()
Returns the type of the keystore used for key locator.

Returns:
password used to check the integrity of the keystore used for key locator or the password used to unlock the keystore

setKeyStorePassword

public void setKeyStorePassword(char[] keyStorePassword)
Sets the type of the keystore used for key locator.

Parameters:
storePassword - the password used to check the integrity of the keystore or the password used to unlock the keystore

getAlias

public java.lang.String getAlias()
Returns the alias name.

Returns:
alias name

setAlias

public void setAlias(java.lang.String alias)
Sets the type of the keystore.

Parameters:
alias - alias name

getKeyPassword

public char[] getKeyPassword()
Returns the password for recovering the key.

Returns:
password for recovering the key

setKeyPassword

public void setKeyPassword(char[] keyPassword)
Sets the password for recovering the key.

Parameters:
keyPassword - the password for recovering the key

getKeyName

public java.lang.String getKeyName()
Returns the name of the key.

Returns:
name of the key

setKeyName

public void setKeyName(java.lang.String keyName)
Sets the name of the key.

Parameters:
keyPassword - the name of the key

isTrustAnyCertificate

public boolean isTrustAnyCertificate()
Returns whether any certificate is trusted or not.

Returns:
true if any certificate is trusted

setTrustAnyCertificate

public void setTrustAnyCertificate(boolean trustAnyCertificate)
Sets whether any certificate is trusted or not.

Parameters:
trustAnyCertificate - true if any certificate is trusted

getTrustAnchorPath

public java.lang.String getTrustAnchorPath()
Returns the file path from which the trust anchor is loaded.

Returns:
path of the trust anchor

setTrustAnchorPath

public void setTrustAnchorPath(java.lang.String trustAnchorPath)
Sets the file path from which the trust anchor is loaded.

Parameters:
trustAnchorPath - path of the trust anchor

getTrustAnchorType

public java.lang.String getTrustAnchorType()
Returns the type of the trust anchor.

Returns:
type of the trust anchor

setTrustAnchorType

public void setTrustAnchorType(java.lang.String trustAnchorType)
Sets the type of the trust anchor.

Parameters:
trustAnchorType - type of the trust anchor

getTrustAnchorPassword

public char[] getTrustAnchorPassword()
Returns the type of the trust anchor.

Returns:
password used to check the integrity of the trust anchor or the password used to unlock the trust anchor

setTrustAnchorPassword

public void setTrustAnchorPassword(char[] trustAnchorPassword)
Sets the type of the trust anchor.

Parameters:
storePassword - the password used to check the integrity of the trust anchor or the password used to unlock the trust anchor

getCertStores

public java.util.List getCertStores()
Returns the list of certificate stores.

Returns:
list of certificate stores

setCertStores

public void setCertStores(java.util.List certStores)
Sets the list of certificate stores.

Parameters:
certStores - the list of certificate stores

getProvider

public java.security.Provider getProvider()
Returns the security provider.

Returns:
security provider

setProvider

public void setProvider(java.security.Provider provider)
Sets the security provider.

Parameters:
provider - security provider

getCertPathParameter

public java.security.cert.PKIXBuilderParameters getCertPathParameter()
Returns the parameter used to check the path of X.509 certificates.

Returns:
parameter used to check the path of X.509 certificates

setCertPathParameter

public void setCertPathParameter(java.security.cert.PKIXBuilderParameters certPathParam)
Sets the parameter used to check the path of X.509 certificates.

Parameters:
certPathParam - parameter used to check the path of X.509 certificates

IBM WebSphere Application ServerTM
Release 7