Spring Web Services Framework

org.springframework.ws.server.endpoint
Class AbstractEndpointExceptionResolver

java.lang.Object
  extended by org.springframework.ws.server.endpoint.AbstractEndpointExceptionResolver
All Implemented Interfaces:
Ordered, EndpointExceptionResolver
Direct Known Subclasses:
AbstractSoapFaultDefinitionExceptionResolver, SimpleSoapExceptionResolver

public abstract class AbstractEndpointExceptionResolver
extends Object
implements EndpointExceptionResolver, Ordered

Abstract base class for EndpointExceptionResolvers.

Provides a set of mapped endpoints that the resolver should map.

Since:
1.0.0
Author:
Arjen Poutsma, Tareq Abed Rabbo

Field Summary
protected  Log logger
          Shared Log for subclasses to use.
 
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
 
Constructor Summary
AbstractEndpointExceptionResolver()
           
 
Method Summary
protected  String buildLogMessage(Exception ex, MessageContext messageContext)
          Build a log message for the given exception, occured during processing the given message context.
 int getOrder()
           
protected  void logException(Exception ex, MessageContext messageContext)
          Log the given exception at warn level, provided that warn logging has been activated through the "warnLogCategory" property.
 boolean resolveException(MessageContext messageContext, Object endpoint, Exception ex)
          Default implementation that checks whether the given endpoint is in the set of mapped endpoints.
protected abstract  boolean resolveExceptionInternal(MessageContext messageContext, Object endpoint, Exception ex)
          Template method for resolving exceptions that is called by resolveException(org.springframework.ws.context.MessageContext, java.lang.Object, java.lang.Exception).
 void setMappedEndpoints(Set mappedEndpoints)
          Specify the set of endpoints that this exception resolver should map.
 void setOrder(int order)
          Specify the order value for this mapping.
 void setWarnLogCategory(String loggerName)
          Set the log category for warn logging.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected final Log logger
Shared Log for subclasses to use.

Constructor Detail

AbstractEndpointExceptionResolver

public AbstractEndpointExceptionResolver()
Method Detail

setMappedEndpoints

public void setMappedEndpoints(Set mappedEndpoints)
Specify the set of endpoints that this exception resolver should map.

The exception mappings and the default fault will only apply to the specified endpoints.

If no endpoints are set, both the exception mappings and the default fault will apply to all handlers. This means that a specified default fault will be used as fallback for all exceptions; any further EndpointExceptionResolvers in the chain will be ignored in this case.


setWarnLogCategory

public void setWarnLogCategory(String loggerName)
Set the log category for warn logging. The name will be passed to the underlying logger implementation through Commons Logging, getting interpreted as log category according to the logger's configuration.

Default is no warn logging. Specify this setting to activate warn logging into a specific category. Alternatively, override the logException(java.lang.Exception, org.springframework.ws.context.MessageContext) method for custom logging.

See Also:
LogFactory.getLog(String), org.apache.log4j.Logger#getLogger(String), Logger

setOrder

public final void setOrder(int order)
Specify the order value for this mapping.

Default value is Integer.MAX_VALUE, meaning that it's non-ordered.

See Also:
Ordered.getOrder()

getOrder

public final int getOrder()
Specified by:
getOrder in interface Ordered

resolveException

public final boolean resolveException(MessageContext messageContext,
                                      Object endpoint,
                                      Exception ex)
Default implementation that checks whether the given endpoint is in the set of mapped endpoints.

Specified by:
resolveException in interface EndpointExceptionResolver
Parameters:
messageContext - current message context
endpoint - the executed endpoint, or null if none chosen at the time of the exception
ex - the exception that got thrown during endpoint execution
Returns:
true if resolved; false otherwise
See Also:
resolveExceptionInternal(MessageContext,Object,Exception)

logException

protected void logException(Exception ex,
                            MessageContext messageContext)
Log the given exception at warn level, provided that warn logging has been activated through the "warnLogCategory" property.

Calls buildLogMessage(java.lang.Exception, org.springframework.ws.context.MessageContext) in order to determine the concrete message to log. Always passes the full exception to the logger.

Parameters:
ex - the exception that got thrown during handler execution
messageContext - current message context request
See Also:
setWarnLogCategory(java.lang.String), buildLogMessage(java.lang.Exception, org.springframework.ws.context.MessageContext), Log.warn(Object, Throwable)

buildLogMessage

protected String buildLogMessage(Exception ex,
                                 MessageContext messageContext)
Build a log message for the given exception, occured during processing the given message context.

Parameters:
ex - the exception that got thrown during handler execution
messageContext - the message context
Returns:
the log message to use

resolveExceptionInternal

protected abstract boolean resolveExceptionInternal(MessageContext messageContext,
                                                    Object endpoint,
                                                    Exception ex)
Template method for resolving exceptions that is called by resolveException(org.springframework.ws.context.MessageContext, java.lang.Object, java.lang.Exception).

Parameters:
messageContext - current message context
endpoint - the executed endpoint, or null if none chosen at the time of the exception
ex - the exception that got thrown during endpoint execution
Returns:
true if resolved; false otherwise
See Also:
resolveException(MessageContext,Object,Exception)

Spring Web Services Framework

Copyright © 2005-2010 The Spring Web Services Framework. All Rights Reserved.