org.picketlink.trust.jbossws.handler

Class AbstractPicketLinkTrustHandler<C extends LogicalMessageContext>

java.lang.Object

org.picketlink.trust.jbossws.handler.AbstractPicketLinkTrustHandler<C>

All Implemented Interfaces:

Handler, SOAPHandler

Direct Known Subclasses:

AbstractSAML2Handler, AbstractWSAuthenticationHandler, AbstractWSAuthorizationHandler, BinaryTokenHandler, MapBasedTokenHandler, SamlRequestSecurityTokenHandler

public abstract class AbstractPicketLinkTrustHandler<C extends LogicalMessageContext>
extends Object
implements SOAPHandler

Abstract base class for the PicketLink Trust Handlers

This class implements directly the SOAPHandler interface because the org.jboss.wsf.common.handler.GenericSOAPHandler package name changes between JBossWS versions.

Since:

Apr 11, 2011

Author:

Anil.Saldhana@redhat.com, Pedro Silva

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AUTHZ_MGR_LOOKUP
protected static Set<QName>	headers
protected static PicketLinkLogger	logger
protected static String	SEC_MGR_LOOKUP

Constructor Summary

Constructors

Constructor and Description
AbstractPicketLinkTrustHandler()

Method Summary

Modifier and Type	Method and Description
void	close(MessageContext context) Called at the conclusion of a message exchange pattern just prior to the JAX-WS runtime disptaching a message, fault or exception.
protected Element	getAssertionFromSubject() Get the SAML Assertion from the subject
Set<QName>	getHeaders() Gets the header blocks that can be processed by this Handler instance.
protected String	getSecurityDomainName(MessageContext msgContext) Returns the security domain name configured for the deployment.
protected Element	getSecurityHeaderElement(Document document) Given a Document, create the WSSE element
protected ServletContext	getServletContext(MessageContext msgContext) Utility method to get the ServletContext from the specified MessageContext.
protected String	getUsername(Element nameID) Given the NameID Element, return the user name
boolean	handleFault(MessageContext context) The handleFault method is invoked for fault message processing.
protected boolean	handleInbound(MessageContext msgContext)
boolean	handleMessage(MessageContext msgContext) Handles the incoming message and decides which method should be called: handleOutbound or handleInbound
protected boolean	handleOutbound(MessageContext msgContext)
protected Object	lookupJNDI(String str)
protected void	trace(MessageContext msgContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static final PicketLinkLogger logger

headers

protected static Set<QName> headers

SEC_MGR_LOOKUP

protected static final String SEC_MGR_LOOKUP

See Also:

Constant Field Values

AUTHZ_MGR_LOOKUP

protected static final String AUTHZ_MGR_LOOKUP

See Also:

Constant Field Values

Constructor Detail

AbstractPicketLinkTrustHandler

public AbstractPicketLinkTrustHandler()

Method Detail

getHeaders

public Set<QName> getHeaders()

Description copied from interface: SOAPHandler

Gets the header blocks that can be processed by this Handler instance.

Specified by:

getHeaders in interface SOAPHandler

Returns:

Set of QNames of header blocks processed by this handler instance. QName is the qualified name of the outermost element of the Header block.

getServletContext

protected ServletContext getServletContext(MessageContext msgContext)

Utility method to get the ServletContext from the specified MessageContext.

Parameters:

msgContext -

Returns:

getSecurityDomainName

protected String getSecurityDomainName(MessageContext msgContext)
                                throws ConfigurationException

Returns the security domain name configured for the deployment.

Parameters:

msgContext -

Returns:

Throws:

ConfigurationException - if no security domain is configured.

getSecurityHeaderElement

protected Element getSecurityHeaderElement(Document document)

Given a Document, create the WSSE element

Parameters:

document -

Returns:

trace

protected void trace(MessageContext msgContext)

getUsername

protected String getUsername(Element nameID)

Given the NameID Element, return the user name

Parameters:

nameID -

Returns:

getAssertionFromSubject

protected Element getAssertionFromSubject()

Get the SAML Assertion from the subject

Returns:

lookupJNDI

protected Object lookupJNDI(String str)

handleMessage

public boolean handleMessage(MessageContext msgContext)

Handles the incoming message and decides which method should be called: handleOutbound or handleInbound

.

Specified by:

handleMessage in interface Handler

Parameters:

msgContext -

Returns:

handleOutbound

protected boolean handleOutbound(MessageContext msgContext)

handleInbound

protected boolean handleInbound(MessageContext msgContext)

handleFault

public boolean handleFault(MessageContext context)

Description copied from interface: Handler

The handleFault method is invoked for fault message processing. Refer to the description of the handler framework in the JAX-WS specification for full details.

Specified by:

handleFault in interface Handler

Parameters:

context - the message context

Returns:

An indication of whether handler fault processing should continue for the current message

• Return true to continue processing.
• Return false to block processing.

close

public void close(MessageContext context)

Description copied from interface: Handler

Called at the conclusion of a message exchange pattern just prior to the JAX-WS runtime disptaching a message, fault or exception. Refer to the description of the handler framework in the JAX-WS specification for full details.

Specified by:

close in interface Handler

Parameters:

context - the message context