org.dataone.cn.rest.proxy

Class AbstractProxyForwarder

java.lang.Object

org.dataone.cn.rest.proxy.AbstractProxyForwarder

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.web.context.ServletContextAware

Direct Known Subclasses:

ResolveForwarder

public abstract class AbstractProxyForwarder
extends Object
implements org.springframework.web.context.ServletContextAware

Takes a request and then forwards the request to another web app. Specifically, for d1-cn-rest, it will take a request for getSystemMetadata and forward the request to Metacat The only subclass is the ResolveForwarder, but the abstract class is generic enough to be reused for other contexts.

Author:

waltz

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.ServletContext	servletContext
protected org.apache.commons.codec.net.URLCodec	urlCodec

Constructor Summary

Constructors

Constructor and Description
AbstractProxyForwarder(javax.servlet.ServletContext servletContext)

Method Summary

Modifier and Type	Method and Description
protected void	debugRequest(javax.servlet.http.HttpServletRequest request)
protected void	debugWrapper(javax.servlet.http.HttpServletRequest request, org.dataone.cn.servlet.http.ProxyServletRequestWrapper proxyServletWrapper)
abstract void	forward(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String version)
protected void	forwardRequest(javax.servlet.ServletContext servletContext, String contextName, org.dataone.cn.servlet.http.ProxyServletRequestWrapper proxyServletWrapper, javax.servlet.http.HttpServletResponse response)
javax.servlet.ServletContext	getServletContext(javax.servlet.ServletContext servletContext)
void	handleBaseException(org.dataone.service.exceptions.BaseException exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.AuthenticationTimeout exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.IdentifierNotUnique exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.InsufficientResources exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.InvalidCredentials exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.InvalidRequest exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.InvalidSystemMetadata exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.InvalidToken exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(IOException exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.exceptions.MarshallingException exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.NotAuthorized exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.NotFound exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.NotImplemented exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.ServiceFailure exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.UnsupportedMetadataType exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(UnsupportedOperationException exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(org.dataone.service.exceptions.UnsupportedType exception, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setServletContext(javax.servlet.ServletContext servletContext)

Methods inherited from class java.lang.Object

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

Field Detail

urlCodec

protected org.apache.commons.codec.net.URLCodec urlCodec

servletContext

protected javax.servlet.ServletContext servletContext

Constructor Detail

AbstractProxyForwarder

public AbstractProxyForwarder(javax.servlet.ServletContext servletContext)

Method Detail

forward

public abstract void forward(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             String version)
                      throws org.dataone.service.exceptions.ServiceFailure,
                             org.dataone.service.exceptions.NotFound,
                             org.dataone.service.exceptions.NotImplemented,
                             org.dataone.service.exceptions.InvalidRequest

Throws:

org.dataone.service.exceptions.ServiceFailure

org.dataone.service.exceptions.NotFound

org.dataone.service.exceptions.NotImplemented

org.dataone.service.exceptions.InvalidRequest

forwardRequest

protected void forwardRequest(javax.servlet.ServletContext servletContext,
                              String contextName,
                              org.dataone.cn.servlet.http.ProxyServletRequestWrapper proxyServletWrapper,
                              javax.servlet.http.HttpServletResponse response)
                       throws javax.servlet.ServletException,
                              IOException,
                              org.dataone.service.exceptions.NotFound,
                              org.dataone.service.exceptions.ServiceFailure

Throws:

javax.servlet.ServletException

IOException

org.dataone.service.exceptions.NotFound

org.dataone.service.exceptions.ServiceFailure

debugWrapper

protected void debugWrapper(javax.servlet.http.HttpServletRequest request,
                            org.dataone.cn.servlet.http.ProxyServletRequestWrapper proxyServletWrapper)

handleException

@ResponseStatus(value=REQUEST_TIMEOUT)
 @ExceptionHandler(value=org.dataone.service.exceptions.AuthenticationTimeout.class)
public void handleException(org.dataone.service.exceptions.AuthenticationTimeout exception,
                                                                                                                                                        javax.servlet.http.HttpServletRequest request,
                                                                                                                                                        javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=CONFLICT)
 @ExceptionHandler(value=org.dataone.service.exceptions.IdentifierNotUnique.class)
public void handleException(org.dataone.service.exceptions.IdentifierNotUnique exception,
                                                                                                                                               javax.servlet.http.HttpServletRequest request,
                                                                                                                                               javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=REQUEST_ENTITY_TOO_LARGE)
 @ExceptionHandler(value=org.dataone.service.exceptions.InsufficientResources.class)
public void handleException(org.dataone.service.exceptions.InsufficientResources exception,
                                                                                                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                 javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=UNAUTHORIZED)
 @ExceptionHandler(value=org.dataone.service.exceptions.InvalidCredentials.class)
public void handleException(org.dataone.service.exceptions.InvalidCredentials exception,
                                                                                                                                                  javax.servlet.http.HttpServletRequest request,
                                                                                                                                                  javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=BAD_REQUEST)
 @ExceptionHandler(value=org.dataone.service.exceptions.InvalidRequest.class)
public void handleException(org.dataone.service.exceptions.InvalidRequest exception,
                                                                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                                                                             javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=BAD_REQUEST)
 @ExceptionHandler(value=org.dataone.service.exceptions.InvalidSystemMetadata.class)
public void handleException(org.dataone.service.exceptions.InvalidSystemMetadata exception,
                                                                                                                                                    javax.servlet.http.HttpServletRequest request,
                                                                                                                                                    javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=UNAUTHORIZED)
 @ExceptionHandler(value=org.dataone.service.exceptions.InvalidToken.class)
public void handleException(org.dataone.service.exceptions.InvalidToken exception,
                                                                                                                                            javax.servlet.http.HttpServletRequest request,
                                                                                                                                            javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=UNAUTHORIZED)
 @ExceptionHandler(value=org.dataone.service.exceptions.NotAuthorized.class)
public void handleException(org.dataone.service.exceptions.NotAuthorized exception,
                                                                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                                                                             javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=NOT_FOUND)
 @ExceptionHandler(value=org.dataone.service.exceptions.NotFound.class)
public void handleException(org.dataone.service.exceptions.NotFound exception,
                                                                                                                                     javax.servlet.http.HttpServletRequest request,
                                                                                                                                     javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=NOT_IMPLEMENTED)
 @ExceptionHandler(value=org.dataone.service.exceptions.NotImplemented.class)
public void handleException(org.dataone.service.exceptions.NotImplemented exception,
                                                                                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                                                                                 javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=INTERNAL_SERVER_ERROR)
 @ExceptionHandler(value=org.dataone.service.exceptions.ServiceFailure.class)
public void handleException(org.dataone.service.exceptions.ServiceFailure exception,
                                                                                                                                                       javax.servlet.http.HttpServletRequest request,
                                                                                                                                                       javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=BAD_REQUEST)
 @ExceptionHandler(value=org.dataone.service.exceptions.UnsupportedMetadataType.class)
public void handleException(org.dataone.service.exceptions.UnsupportedMetadataType exception,
                                                                                                                                                      javax.servlet.http.HttpServletRequest request,
                                                                                                                                                      javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=BAD_REQUEST)
 @ExceptionHandler(value=org.dataone.service.exceptions.UnsupportedType.class)
public void handleException(org.dataone.service.exceptions.UnsupportedType exception,
                                                                                                                                              javax.servlet.http.HttpServletRequest request,
                                                                                                                                              javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=NOT_IMPLEMENTED)
 @ExceptionHandler(value=java.lang.UnsupportedOperationException.class)
public void handleException(UnsupportedOperationException exception,
                                                                                                                                           javax.servlet.http.HttpServletRequest request,
                                                                                                                                           javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=INTERNAL_SERVER_ERROR)
 @ExceptionHandler(value=java.io.IOException.class)
public void handleException(IOException exception,
                                                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                                                             javax.servlet.http.HttpServletResponse response)

handleException

@ResponseStatus(value=INTERNAL_SERVER_ERROR)
 @ExceptionHandler(value=org.dataone.exceptions.MarshallingException.class)
public void handleException(org.dataone.exceptions.MarshallingException exception,
                                                                                                                                                     javax.servlet.http.HttpServletRequest request,
                                                                                                                                                     javax.servlet.http.HttpServletResponse response)

handleBaseException

public void handleBaseException(org.dataone.service.exceptions.BaseException exception,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)

debugRequest

protected void debugRequest(javax.servlet.http.HttpServletRequest request)

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware

getServletContext

public javax.servlet.ServletContext getServletContext(javax.servlet.ServletContext servletContext)