|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ws.security.handler.WSHandler
public abstract class WSHandler
Extracted from WSDoAllReceiver and WSDoAllSender Extended to all passwordless UsernameTokens and configurable identities.
Field Summary | |
---|---|
protected Map<String,Crypto> |
cryptos
|
protected WSSecurityEngine |
secEngine
|
Constructor Summary | |
---|---|
WSHandler()
|
Method Summary | |
---|---|
protected boolean |
checkReceiverResults(List<WSSecurityEngineResult> wsResult,
List<Integer> actions)
|
protected boolean |
checkReceiverResultsAnyOrder(List<WSSecurityEngineResult> wsResult,
List<Integer> actions)
|
protected void |
checkSignatureConfirmation(RequestData reqData,
List<WSSecurityEngineResult> resultList)
|
protected boolean |
decodeBooleanConfigValue(RequestData reqData,
String configTag,
boolean defaultToTrue)
|
protected boolean |
decodeBSPCompliance(RequestData reqData)
|
protected boolean |
decodeCustomPasswordTypes(RequestData reqData)
|
protected void |
decodeDecryptionParameter(RequestData reqData)
|
protected boolean |
decodeEnableSignatureConfirmation(RequestData reqData)
|
protected void |
decodeEncryptionParameter(RequestData reqData)
|
protected int |
decodeFutureTimeToLive(RequestData reqData)
|
protected boolean |
decodeMustUnderstand(RequestData reqData)
|
protected boolean |
decodeNamespaceQualifiedPasswordTypes(RequestData reqData)
|
protected String |
decodePasswordType(RequestData reqData)
|
protected boolean |
decodePasswordTypeStrict(RequestData reqData)
|
protected void |
decodeSignatureParameter(RequestData reqData)
|
protected void |
decodeSignatureParameter2(RequestData reqData)
|
protected boolean |
decodeTimestampPrecision(RequestData reqData)
|
protected boolean |
decodeTimestampStrict(RequestData reqData)
|
int |
decodeTimeToLive(RequestData reqData)
|
protected boolean |
decodeUseEncodedPasswords(RequestData reqData)
|
protected boolean |
decodeUseSingleCertificate(RequestData reqData)
|
protected void |
decodeUTParameter(RequestData reqData)
|
protected void |
doReceiverAction(int doAction,
RequestData reqData)
|
protected void |
doSenderAction(int doAction,
Document doc,
RequestData reqData,
List<Integer> actions,
boolean isRequest)
Performs all defined security actions to set-up the SOAP request. |
CallbackHandler |
getCallbackHandler(String callbackHandlerClass,
String callbackHandlerRef,
RequestData requestData)
Get a CallbackHandler instance. |
ClassLoader |
getClassLoader(Object msgCtx)
Returns the classloader to be used for loading the callback class |
abstract Object |
getOption(String key)
|
abstract String |
getPassword(Object msgContext)
|
CallbackHandler |
getPasswordCallbackHandler(RequestData reqData)
Get a CallbackHandler instance to obtain passwords. |
WSPasswordCallback |
getPasswordCB(String username,
int doAction,
CallbackHandler callbackHandler,
RequestData requestData)
Get a password callback (WSPasswordCallback object) from a CallbackHandler instance |
abstract Object |
getProperty(Object msgContext,
String key)
|
String |
getString(String key,
Object mc)
Looks up key first via getOption(String) and if not found
there, via getProperty(Object, String) |
String |
getStringOption(String key)
Returns the option on name . |
protected Crypto |
loadCrypto(String cryptoPropertyFile,
String cryptoPropertyRefId,
RequestData requestData)
Load a Crypto instance. |
protected Crypto |
loadCryptoFromPropertiesFile(String propFilename,
RequestData reqData)
A hook to allow subclass to load Crypto instances from property files in a different way. |
protected Crypto |
loadDecryptionCrypto(RequestData requestData)
Hook to allow subclasses to load their Decryption Crypto however they see fit. |
protected Crypto |
loadEncryptionCrypto(RequestData requestData)
Hook to allow subclasses to load their Encryption Crypto however they see fit. |
Crypto |
loadSignatureCrypto(RequestData requestData)
Hook to allow subclasses to load their Signature Crypto however they see fit. |
abstract void |
setPassword(Object msgContext,
String password)
|
abstract void |
setProperty(Object msgContext,
String key,
Object value)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected WSSecurityEngine secEngine
protected Map<String,Crypto> cryptos
Constructor Detail |
---|
public WSHandler()
Method Detail |
---|
protected void doSenderAction(int doAction, Document doc, RequestData reqData, List<Integer> actions, boolean isRequest) throws WSSecurityException
doAction
- a set defining the actions to dodoc
- the request as DOM documentreqData
- a data storage to pass values around between methodsactions
- a list holding the actions to do in the order defined
in the deployment file or property
WSSecurityException
protected void doReceiverAction(int doAction, RequestData reqData) throws WSSecurityException
WSSecurityException
protected boolean checkReceiverResults(List<WSSecurityEngineResult> wsResult, List<Integer> actions)
protected boolean checkReceiverResultsAnyOrder(List<WSSecurityEngineResult> wsResult, List<Integer> actions)
protected void checkSignatureConfirmation(RequestData reqData, List<WSSecurityEngineResult> resultList) throws WSSecurityException
WSSecurityException
protected void decodeUTParameter(RequestData reqData) throws WSSecurityException
WSSecurityException
protected void decodeSignatureParameter(RequestData reqData) throws WSSecurityException
WSSecurityException
protected void decodeEncryptionParameter(RequestData reqData) throws WSSecurityException
WSSecurityException
public int decodeTimeToLive(RequestData reqData)
protected int decodeFutureTimeToLive(RequestData reqData)
protected boolean decodeBSPCompliance(RequestData reqData) throws WSSecurityException
WSSecurityException
protected String decodePasswordType(RequestData reqData) throws WSSecurityException
WSSecurityException
protected boolean decodeMustUnderstand(RequestData reqData) throws WSSecurityException
WSSecurityException
protected boolean decodeEnableSignatureConfirmation(RequestData reqData) throws WSSecurityException
WSSecurityException
protected boolean decodeTimestampPrecision(RequestData reqData) throws WSSecurityException
WSSecurityException
protected boolean decodeCustomPasswordTypes(RequestData reqData) throws WSSecurityException
WSSecurityException
protected boolean decodeUseEncodedPasswords(RequestData reqData) throws WSSecurityException
WSSecurityException
protected boolean decodeNamespaceQualifiedPasswordTypes(RequestData reqData) throws WSSecurityException
WSSecurityException
protected boolean decodeTimestampStrict(RequestData reqData) throws WSSecurityException
WSSecurityException
protected boolean decodePasswordTypeStrict(RequestData reqData) throws WSSecurityException
WSSecurityException
protected boolean decodeUseSingleCertificate(RequestData reqData) throws WSSecurityException
WSSecurityException
protected boolean decodeBooleanConfigValue(RequestData reqData, String configTag, boolean defaultToTrue) throws WSSecurityException
WSSecurityException
public Crypto loadSignatureCrypto(RequestData requestData) throws WSSecurityException
requestData
- the RequestData object
WSSecurityException
protected Crypto loadDecryptionCrypto(RequestData requestData) throws WSSecurityException
requestData
- the RequestData object
WSSecurityException
protected Crypto loadEncryptionCrypto(RequestData requestData) throws WSSecurityException
requestData
- the RequestData object
WSSecurityException
protected Crypto loadCrypto(String cryptoPropertyFile, String cryptoPropertyRefId, RequestData requestData) throws WSSecurityException
requestData
- the RequestData object
WSSecurityException
protected Crypto loadCryptoFromPropertiesFile(String propFilename, RequestData reqData) throws WSSecurityException
propFilename
- The property file namereqData
- The RequestData object
WSSecurityException
public CallbackHandler getCallbackHandler(String callbackHandlerClass, String callbackHandlerRef, RequestData requestData) throws WSSecurityException
callbackHandlerClass
- The class name of the CallbackHandler instancecallbackHandlerRef
- The reference name of the CallbackHandler instancerequestData
- The RequestData which supplies the message context
WSSecurityException
public CallbackHandler getPasswordCallbackHandler(RequestData reqData) throws WSSecurityException
reqData
- The RequestData which supplies the message context
WSSecurityException
public WSPasswordCallback getPasswordCB(String username, int doAction, CallbackHandler callbackHandler, RequestData requestData) throws WSSecurityException
username
- The username to supply to the CallbackHandlerdoAction
- The action to performcallbackHandler
- The CallbackHandler instancerequestData
- The RequestData which supplies the message context
WSSecurityException
protected void decodeSignatureParameter2(RequestData reqData) throws WSSecurityException
WSSecurityException
protected void decodeDecryptionParameter(RequestData reqData) throws WSSecurityException
WSSecurityException
public String getString(String key, Object mc)
getOption(String)
and if not found
there, via getProperty(Object, String)
key
- the key to search for. May not be null.mc
- the message context to search.
IllegalArgumentException
- if key
is null.public String getStringOption(String key)
name
.
key
- the non-null key of the option.
key
if key
exists and is of type java.lang.String; otherwise null.public ClassLoader getClassLoader(Object msgCtx)
msgCtx
- The MessageContext
public abstract Object getOption(String key)
public abstract Object getProperty(Object msgContext, String key)
public abstract void setProperty(Object msgContext, String key, Object value)
public abstract String getPassword(Object msgContext)
public abstract void setPassword(Object msgContext, String password)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |