org.mailster.pop3.commands.auth
Class AuthAlgorithmCommand

java.lang.Object
  org.mailster.pop3.commands.Pop3Command
      org.mailster.pop3.commands.MultiStatePop3Command
          org.mailster.pop3.commands.auth.AuthAlgorithmCommand

Direct Known Subclasses:

AuthCramCommand, AuthDigestMD5Command, AuthLoginCommand, AuthPlainCommand

public abstract class AuthAlgorithmCommand
extends MultiStatePop3Command

---
Mailster (C) 2007-2009 De Oliveira Edouard

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

See Mailster Web Site
---

AuthAlgorithmCommand.java - An abstract class for the different AUTH algorithms implementations.

Version:

$Revision: 1.4 $, $Date: 2009/02/03 00:29:41 $

Author:

Edouard De Oliveira

Field Summary

static int

CHECK_RESPONSE_TO_CHALLENGE_STATE Checking client response to challenge state.

Constructor Summary

AuthAlgorithmCommand()

Method Summary

abstract Pop3CommandState	challengeClient(AbstractPop3Handler handler, AbstractPop3Connection conn, java.lang.String cmd)
abstract Pop3CommandState	checkClientResponse(AbstractPop3Handler handler, AbstractPop3Connection conn, java.lang.String cmd)
Pop3CommandState	execute(AbstractPop3Handler handler, AbstractPop3Connection conn, java.lang.String cmd, Pop3CommandState state) Executes the command.
boolean	isSecuredAuthenticationMethod()
boolean	isValidForState(Pop3State state) Checks if command is valid for the specified POP3 state.

Methods inherited from class org.mailster.pop3.commands.MultiStatePop3Command

execute

Methods inherited from class org.mailster.pop3.commands.Pop3Command

tryLockingMailbox

Methods inherited from class java.lang.Object

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

Field Detail

CHECK_RESPONSE_TO_CHALLENGE_STATE

public static final int CHECK_RESPONSE_TO_CHALLENGE_STATE

Checking client response to challenge state.

See Also:

Constant Field Values

Constructor Detail

AuthAlgorithmCommand

public AuthAlgorithmCommand()

Method Detail

isValidForState

public boolean isValidForState(Pop3State state)

Description copied from class: Pop3Command

Checks if command is valid for the specified POP3 state.

Specified by:

isValidForState in class Pop3Command

Parameters:

state - the POP3 state

Returns:

true, if is valid for state

checkClientResponse

public abstract Pop3CommandState checkClientResponse(AbstractPop3Handler handler,
                                                     AbstractPop3Connection conn,
                                                     java.lang.String cmd)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

challengeClient

public abstract Pop3CommandState challengeClient(AbstractPop3Handler handler,
                                                 AbstractPop3Connection conn,
                                                 java.lang.String cmd)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

execute

public Pop3CommandState execute(AbstractPop3Handler handler,
                                AbstractPop3Connection conn,
                                java.lang.String cmd,
                                Pop3CommandState state)

Description copied from class: MultiStatePop3Command

Executes the command. If the state returned is different from Pop3CommandState.COMPLETED_STATE or Pop3CommandState.ERROR_STATE, it means that execution of the command needs some additional request/response steps to complete its execution.

Specified by:

execute in class MultiStatePop3Command

Parameters:

handler - a pop3 handler

conn - a pop3 connection

cmd - the command line sent by the client

state - the state of the command execution, if null it's considered to be in the initial state.

Returns:

a Pop3CommandState as the next state of the command

isSecuredAuthenticationMethod

public boolean isSecuredAuthenticationMethod()