org.openmdx.security.auth.servlet.spi
Class AbstractCallbackHandler

java.lang.Object
  org.openmdx.security.auth.servlet.spi.AbstractHandler
      org.openmdx.security.auth.servlet.spi.AbstractCallbackHandler

All Implemented Interfaces:

ServletConfig, HttpCallbackHandler, HttpHandler

Direct Known Subclasses:

SimpleCallbackHandler

public class AbstractCallbackHandler
extends AbstractHandler
implements HttpCallbackHandler

Abstract Callback Handler

Field Summary

static String	LOCAL_ADDR Prompt to retrieve the Internet Protocol (IP) address of the interface on which the request was received.
static String	REMOTE_ADDR Prompt to retrieve the value of the CGI variable REMOTE_ADDR.

Constructor Summary

AbstractCallbackHandler()
Constructor

Method Summary

protected void	endForm(HttpServletRequest request, Writer html) Terminate the FORM including its end tag.
protected String	getToken(Callback[] callbacks) The token should be a valua which changes from callback request to callback request.
boolean	handle(HttpServletRequest request, Callback[] callbacks) One or second phase callback handling
boolean	handle(HttpServletRequest request, HttpServletResponse response, Callback[] callbacks) One or two phase callback handling
protected void	handle(HttpServletRequest request, int index, org.openmdx.kernel.security.authentication.callback.AddressCallback callback) Handle Address Callbacks
protected void	handle(HttpServletRequest request, int index, Callback callback) Handle Callbacks
protected void	handle(HttpServletRequest request, int index, ChoiceCallback callback) Handle Choice Callbacks
protected void	handle(HttpServletRequest request, int index, ConfirmationCallback callback) Handle Confirmation Callbacks
protected void	handle(HttpServletRequest request, int index, LanguageCallback callback) Handle Language Callbacks
protected void	handle(HttpServletRequest request, int index, NameCallback callback) Handle Name Callbacks
protected void	handle(HttpServletRequest request, int index, PasswordCallback callback) Handle Password Callbacks
protected void	handle(HttpServletRequest request, int index, TextInputCallback callback) Handle Text Input Callbacks
protected void	handle(HttpServletRequest request, int index, TextOutputCallback callback) Handle Text output Callbacks
protected void	handle(HttpServletRequest request, int index, TokenCallback callback) Handle Token Callbacks
protected boolean	handle(HttpServletRequest request, Writer html, int index, org.openmdx.kernel.security.authentication.callback.AddressCallback callback) Handle Address Callbacks
protected boolean	handle(HttpServletRequest request, Writer html, int index, Callback callback) Handle Callbacks
protected boolean	handle(HttpServletRequest request, Writer html, int index, ChoiceCallback callback) Handle Choice Callbacks
protected boolean	handle(HttpServletRequest request, Writer html, int index, ConfirmationCallback callback) Handle Confirmation Callbacks
protected boolean	handle(HttpServletRequest request, Writer html, int index, LanguageCallback callback) Handle Language Callbacks
protected boolean	handle(HttpServletRequest request, Writer html, int index, NameCallback callback) Handle Name Callbacks
protected boolean	handle(HttpServletRequest request, Writer html, int index, PasswordCallback callback) Handle Password Callbacks
protected boolean	handle(HttpServletRequest request, Writer html, int index, TextInputCallback callback) Handle Text Input Callbacks
protected boolean	handle(HttpServletRequest request, Writer html, int index, TextOutputCallback callback) Handle Text output Callbacks
protected boolean	handle(HttpServletRequest request, Writer html, int index, TokenCallback callback) Handle Token Callbacks
protected void	startForm(HttpServletRequest request, Writer html) Write the FORM's start tag.

Methods inherited from class org.openmdx.security.auth.servlet.spi.AbstractHandler

debugDefault, destroy, endBody, endDocument, endHead, getInitParameter, getInitParameter, getInitParameter, getInitParameter, getInitParameter, getInitParameterNames, getServletContext, getServletName, init, init, isDebug, log, log, startBody, startDocument, startHead, writeEncoded

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmdx.security.auth.servlet.cci.HttpHandler

destroy, init

Field Detail

REMOTE_ADDR

public static final String REMOTE_ADDR

Prompt to retrieve the value of the CGI variable REMOTE_ADDR.

See Also:

Constant Field Values

LOCAL_ADDR

public static final String LOCAL_ADDR

Prompt to retrieve the Internet Protocol (IP) address of the interface on which the request was received.

See Also:

Constant Field Values

Constructor Detail

AbstractCallbackHandler

public AbstractCallbackHandler()

Constructor

Method Detail

handle

public boolean handle(HttpServletRequest request,
                      HttpServletResponse response,
                      Callback[] callbacks)
               throws IOException,
                      UnsupportedCallbackException

Description copied from interface: HttpCallbackHandler

One or two phase callback handling

Specified by:

handle in interface HttpCallbackHandler

Returns:

true in case of two-phase handling, i.e. if a body has been added to the response and callback handling will be resumed using handle(HttpServletRequest,Callback[]).

Throws:

IOException

UnsupportedCallbackException

startForm

protected void startForm(HttpServletRequest request,
                         Writer html)
                  throws IOException

Write the FORM's start tag.

Parameters:

request -

html -

Throws:

IOException

endForm

protected void endForm(HttpServletRequest request,
                       Writer html)
                throws IOException

Terminate the FORM including its end tag.

Parameters:

request -

html -

Throws:

IOException

handle

protected boolean handle(HttpServletRequest request,
                         Writer html,
                         int index,
                         Callback callback)
                  throws IOException,
                         UnsupportedCallbackException

Handle Callbacks

Parameters:

request -

html - write the to the HTML form

index -

callback -

Returns:

true if a response has been added

Throws:

IOException

UnsupportedCallbackException

handle

protected boolean handle(HttpServletRequest request,
                         Writer html,
                         int index,
                         org.openmdx.kernel.security.authentication.callback.AddressCallback callback)
                  throws IOException,
                         UnsupportedCallbackException

Handle Address Callbacks

Parameters:

request -

html - write the to the HTML form

index -

callback -

Returns:

true if a response has been added

Throws:

IOException

UnsupportedCallbackException

handle

protected boolean handle(HttpServletRequest request,
                         Writer html,
                         int index,
                         ChoiceCallback callback)
                  throws IOException,
                         UnsupportedCallbackException

Handle Choice Callbacks

Parameters:

request -

html - write the to the HTML form

index -

callback -

Returns:

true if a response has been added

Throws:

IOException

UnsupportedCallbackException

handle

protected boolean handle(HttpServletRequest request,
                         Writer html,
                         int index,
                         ConfirmationCallback callback)
                  throws IOException,
                         UnsupportedCallbackException

Handle Confirmation Callbacks

Parameters:

request -

html - write the to the HTML form

index -

callback -

Returns:

true if a response has been added

Throws:

IOException

UnsupportedCallbackException

handle

protected boolean handle(HttpServletRequest request,
                         Writer html,
                         int index,
                         LanguageCallback callback)
                  throws IOException,
                         UnsupportedCallbackException

Handle Language Callbacks

Parameters:

request -

html - write the to the HTML form

index -

callback -

Returns:

true if a response has been added

Throws:

IOException

UnsupportedCallbackException

handle

protected boolean handle(HttpServletRequest request,
                         Writer html,
                         int index,
                         NameCallback callback)
                  throws IOException,
                         UnsupportedCallbackException

Handle Name Callbacks

Parameters:

request -

html - write the to the HTML form

index -

callback -

Returns:

true if a response has been added

Throws:

IOException

UnsupportedCallbackException

handle

protected boolean handle(HttpServletRequest request,
                         Writer html,
                         int index,
                         PasswordCallback callback)
                  throws IOException,
                         UnsupportedCallbackException

Handle Password Callbacks

Parameters:

request -

html - write the to the HTML form

index -

callback -

Returns:

true if a response has been added

Throws:

IOException

UnsupportedCallbackException

handle

protected boolean handle(HttpServletRequest request,
                         Writer html,
                         int index,
                         TextInputCallback callback)
                  throws IOException,
                         UnsupportedCallbackException

Handle Text Input Callbacks

Parameters:

request -

html - write the to the HTML form

index -

callback -

Returns:

true if a response has been added

Throws:

IOException

UnsupportedCallbackException

handle

protected boolean handle(HttpServletRequest request,
                         Writer html,
                         int index,
                         TextOutputCallback callback)
                  throws IOException,
                         UnsupportedCallbackException

Handle Text output Callbacks

Parameters:

request -

html - write the to the HTML form

index -

callback -

Returns:

true if a response has been added

Throws:

IOException

UnsupportedCallbackException

handle

protected boolean handle(HttpServletRequest request,
                         Writer html,
                         int index,
                         TokenCallback callback)
                  throws IOException,
                         UnsupportedCallbackException

Handle Token Callbacks

Parameters:

request -

html - write the to the HTML form

index -

callback -

Returns:

true if a response has been added

Throws:

IOException

UnsupportedCallbackException

handle

public boolean handle(HttpServletRequest request,
                      Callback[] callbacks)
               throws IOException,
                      UnsupportedCallbackException

Description copied from interface: HttpCallbackHandler

One or second phase callback handling

Specified by:

handle in interface HttpCallbackHandler

Throws:

IOException

UnsupportedCallbackException

getToken

protected String getToken(Callback[] callbacks)

The token should be a valua which changes from callback request to callback request.

Parameters:

callbacks -

Returns:

the token value

handle

protected void handle(HttpServletRequest request,
                      int index,
                      Callback callback)
               throws IOException,
                      UnsupportedCallbackException

Handle Callbacks

Parameters:

request -

index -

callback -

Throws:

IOException

UnsupportedCallbackException

handle

protected void handle(HttpServletRequest request,
                      int index,
                      org.openmdx.kernel.security.authentication.callback.AddressCallback callback)
               throws IOException,
                      UnsupportedCallbackException

Handle Address Callbacks

Parameters:

request -

index -

callback -

Throws:

IOException

UnsupportedCallbackException

handle

protected void handle(HttpServletRequest request,
                      int index,
                      ChoiceCallback callback)
               throws IOException,
                      UnsupportedCallbackException

Handle Choice Callbacks

Parameters:

request -

index -

callback -

Throws:

IOException

UnsupportedCallbackException

handle

protected void handle(HttpServletRequest request,
                      int index,
                      ConfirmationCallback callback)
               throws IOException,
                      UnsupportedCallbackException

Handle Confirmation Callbacks

Parameters:

request -

index -

callback -

Throws:

IOException

UnsupportedCallbackException

handle

protected void handle(HttpServletRequest request,
                      int index,
                      LanguageCallback callback)
               throws IOException,
                      UnsupportedCallbackException

Handle Language Callbacks

Parameters:

request -

index -

callback -

Throws:

IOException

UnsupportedCallbackException

handle

protected void handle(HttpServletRequest request,
                      int index,
                      NameCallback callback)
               throws IOException,
                      UnsupportedCallbackException

Handle Name Callbacks

Parameters:

request -

index -

callback -

Throws:

IOException

UnsupportedCallbackException

handle

protected void handle(HttpServletRequest request,
                      int index,
                      PasswordCallback callback)
               throws IOException,
                      UnsupportedCallbackException

Handle Password Callbacks

Parameters:

request -

index -

callback -

Throws:

IOException

UnsupportedCallbackException

handle

protected void handle(HttpServletRequest request,
                      int index,
                      TextInputCallback callback)
               throws IOException,
                      UnsupportedCallbackException

Handle Text Input Callbacks

Parameters:

request -

index -

callback -

Throws:

IOException

UnsupportedCallbackException

handle

protected void handle(HttpServletRequest request,
                      int index,
                      TextOutputCallback callback)
               throws IOException,
                      UnsupportedCallbackException

Handle Text output Callbacks

Parameters:

request -

index -

callback -

Throws:

IOException

UnsupportedCallbackException

handle

protected void handle(HttpServletRequest request,
                      int index,
                      TokenCallback callback)
               throws IOException,
                      UnsupportedCallbackException

Handle Token Callbacks

Parameters:

request -

index -

callback -

Throws:

IOException

UnsupportedCallbackException