org.randomcoder.security
Class UrlMutatingChannelEntryPoint

java.lang.Object
  org.randomcoder.security.UrlMutatingChannelEntryPoint

All Implemented Interfaces:

ChannelEntryPoint

public class UrlMutatingChannelEntryPoint
extends Object
implements ChannelEntryPoint

Acegi ChannelEntryPoint implementation which wraps an existing implemention but provides URL-mutating capabilities.

Specifically, a user-defined list of URL suffixes may be removed from the URL passed to the underlying implementation.

This is useful to remove welcome-file patterns from the redirect sent to the browser on HTTP / HTTPS state transitions.

 Copyright (c) 2006, Craig Condit. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
   * Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
     
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 

Constructor Summary

UrlMutatingChannelEntryPoint()

Method Summary

void	commence(ServletRequest request, ServletResponse response) Processes this channel.
void	setChannelEntryPoint(ChannelEntryPoint channelEntryPoint) Sets the ChannelEntryPoint to wrap.
void	setReplacement(String replacement) Sets the replacement to append when a suffix is removed.
void	setSuffix(String suffix) Sets a single suffix to replace.
void	setSuffixes(String[] suffixes) Sets the list of suffixes to strip from URLs.

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlMutatingChannelEntryPoint

public UrlMutatingChannelEntryPoint()

Method Detail

setChannelEntryPoint

public void setChannelEntryPoint(ChannelEntryPoint channelEntryPoint)

Sets the ChannelEntryPoint to wrap.

Parameters:

channelEntryPoint - channel entry point

setSuffixes

public void setSuffixes(String[] suffixes)

Sets the list of suffixes to strip from URLs.

Defaults to { /index.jsp, /index.html, /index.htm }.

Parameters:

suffixes - array of suffixes to strip

setSuffix

public void setSuffix(String suffix)

Sets a single suffix to replace.

Parameters:

suffix - suffix

setReplacement

public void setReplacement(String replacement)

Sets the replacement to append when a suffix is removed.

Default implementation uses a single "/".

Parameters:

replacement - replacement suffix

commence

public void commence(ServletRequest request,
                     ServletResponse response)
              throws IOException,
                     ServletException

Processes this channel.

This method delegates to the underlying channel entry point, substituting an alternate ServletRequest if url-rewriting is necessary.

Specified by:

commence in interface ChannelEntryPoint

Parameters:

request - servlet request

response - servlet response

Throws:

IOException - if an I/O error occurs

ServletException - if any other error occurs