Package org.mule.soap.api.security

Interface SecurityStrategy

All Known Implementing Classes:

WssDecryptSecurityStrategy, WssEncryptSecurityStrategy, WssGlobalOutgoingSecurityStrategy, WssIncomingTimestampSecurityStrategy, WssSignSecurityStrategy, WssTimestampSecurityStrategy, WssUsernameTokenSecurityStrategy, WssVerifySignatureSecurityStrategy

public interface SecurityStrategy

Base contract for objects that adds a level of security to the SOAP Protocol by preparing a set of CXF properties.

All securities have an Action Name and a Type (Whether should be applied to the SOAP request or SOAP response), and returns a set of properties that needs to be set in the client to make it work.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SecurityStrategy.SecurityStrategyType	Different types of SecurityStrategy that specify when a strategy should be applied to a message.

Method Summary

Modifier and Type	Method	Description
Optional<WSPasswordCallbackHandler>	buildPasswordCallbackHandler()	Gives the option to return a custom WSPasswordCallbackHandler instance allowing to compose many password handlers from different security strategies.
Map<String,Object>	buildSecurityProperties()	Returns a set of properties to be set on the SOAP request interceptors (OUT interceptors) in order to applies this security strategy.
String	securityAction()	Returns the security action name that is going to be executed in the request phase (OUT interceptors).
SecurityStrategy.SecurityStrategyType	securityType()	Returns the type of the security strategy, if applies for the request or the response.

Method Details

securityAction

String securityAction()

Returns the security action name that is going to be executed in the request phase (OUT interceptors).

Returns:

the request action name of this security strategy.

securityType

SecurityStrategy.SecurityStrategyType securityType()

Returns the type of the security strategy, if applies for the request or the response.

Returns:

whether is the security strategy applies for the request or the response.

buildSecurityProperties

Map<String,Object> buildSecurityProperties()

Returns a set of properties to be set on the SOAP request interceptors (OUT interceptors) in order to applies this security strategy.

Returns:

a Map with the properties required to apply the security strategy.

buildPasswordCallbackHandler

Optional<WSPasswordCallbackHandler> buildPasswordCallbackHandler()

Gives the option to return a custom WSPasswordCallbackHandler instance allowing to compose many password handlers from different security strategies.

Returns:

an optional WSPasswordCallbackHandler to be added to the composite callback handler.