Return to www.inductionframework.org

com.acciente.induction.resolver
Interface RedirectResolver

All Known Implementing Classes:
ShortURLRedirectResolver

public interface RedirectResolver

This interface is used to abstract the algorithm used to map a redirect request to an actual URL

A class implementing this interface is expected to have a single public contructor adhering to the following convention:

- the single constructor should accepts no arguments or

- the single constructor should declare formal parameters using only the following types:

- javax.servlet.ServletContext

Author:
Adinath Raveendra Raj

Method Summary
 java.lang.String resolve(java.lang.Class oTargetClass)
          Called by Induction to resolve a redirect request defined on in terms of a target controller or view.
 java.lang.String resolve(java.lang.Class oTargetClass, java.util.Map oURLQueryParameters)
          Called by Induction to resolve a redirect request defined on in terms of a target controller or view and map of query parameters.
 java.lang.String resolve(java.lang.Class oControllerClass, java.lang.String sControllerMethodName)
          Called by Induction to resolve a redirect request defined on in terms of a target controller and a specific target method in the controller.
 java.lang.String resolve(java.lang.Class oControllerClass, java.lang.String sControllerMethodName, java.util.Map oURLQueryParameters)
          Called by Induction to resolve a redirect request defined on in terms of a target controller and a specific target method in the controller and has URL query parameters.
 java.lang.String resolve(java.lang.String sURLPart)
          Called by Induction to resolve a redirect request defined on in terms of a target URL, the URL may be a partial URL that this method is expected to complete.
 java.lang.String resolve(java.lang.String sURLPart, java.util.Map oURLQueryParameters)
          Called by Induction to resolve a redirect request defined on in terms of a target URL and URL query parameters.
 

Method Detail

resolve

java.lang.String resolve(java.lang.Class oTargetClass)
Called by Induction to resolve a redirect request defined on in terms of a target controller or view.

Parameters:
oTargetClass - a class object representing a class that implements the Controller or interface or a view
Returns:
a string represting a complete URL

resolve

java.lang.String resolve(java.lang.Class oTargetClass,
                         java.util.Map oURLQueryParameters)
Called by Induction to resolve a redirect request defined on in terms of a target controller or view and map of query parameters.

Parameters:
oTargetClass - a class object representing a class that implements the Controller or interface or a view
oURLQueryParameters - a map to be converted to URL query parameters
Returns:
a string represting a complete URL

resolve

java.lang.String resolve(java.lang.Class oControllerClass,
                         java.lang.String sControllerMethodName)
Called by Induction to resolve a redirect request defined on in terms of a target controller and a specific target method in the controller.

Parameters:
oControllerClass - a class object representing a class that implements the Controller interface
sControllerMethodName - a specific method name in the controller that the client should redirect to
Returns:
a string represting a complete URL

resolve

java.lang.String resolve(java.lang.Class oControllerClass,
                         java.lang.String sControllerMethodName,
                         java.util.Map oURLQueryParameters)
Called by Induction to resolve a redirect request defined on in terms of a target controller and a specific target method in the controller and has URL query parameters.

Parameters:
oControllerClass - a class object representing a class that implements the Controller interface
sControllerMethodName - a specific method name in the controller that the client should redirect to
oURLQueryParameters - a map to be converted to URL query parameters
Returns:
a string represting a complete URL

resolve

java.lang.String resolve(java.lang.String sURLPart)
Called by Induction to resolve a redirect request defined on in terms of a target URL, the URL may be a partial URL that this method is expected to complete. The URL may even simply be a mnemonic reference that is mapped to a complete URL by this method.

Parameters:
sURLPart - a string representing a complete or partial URL
Returns:
a string represting a complete URL

resolve

java.lang.String resolve(java.lang.String sURLPart,
                         java.util.Map oURLQueryParameters)
Called by Induction to resolve a redirect request defined on in terms of a target URL and URL query parameters. The URL may be a partial URL that this method is expected to complete. The URL may even simply be a mnemonic reference that is mapped to a complete URL by this method.

Parameters:
sURLPart - a string representing a complete or partial URL
oURLQueryParameters - a map to be converted to URL query parameters
Returns:
a string represting a complete URL

Return to www.inductionframework.org

Copyright © 2008-2009 Acciente, LLC. All Rights Reserved.