org.mailster.pop3.commands.auth
Class AuthCommand

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

All Implemented Interfaces:

CapabilitiesInterface

public class AuthCommand
extends MultiStatePop3Command
implements CapabilitiesInterface

---
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
---

AuthCommand.java - The POP3 AUTH command (see RFC 1734).

Version:

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

Author:

Edouard De Oliveira

Field Summary

private static java.util.HashMap<java.lang.String,AuthAlgorithmCommand>

algorithms

Constructor Summary

AuthCommand()

Method Summary

Pop3CommandState	execute(AbstractPop3Handler handler, AbstractPop3Connection conn, java.lang.String cmd, Pop3CommandState state) Executes the command.
java.lang.String	getCapability() Returns the capability string reported by the CAPA command.
boolean	isValidForState(Pop3State state) Checks if command is valid for the specified POP3 state.
static void	register(java.lang.String algorithm, AuthAlgorithmCommand cmd)
static void	unregister(java.lang.String algorithm)

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

algorithms

private static java.util.HashMap<java.lang.String,AuthAlgorithmCommand> algorithms

Constructor Detail

AuthCommand

public AuthCommand()

Method Detail

register

public static void register(java.lang.String algorithm,
                            AuthAlgorithmCommand cmd)

unregister

public static void unregister(java.lang.String algorithm)

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

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

getCapability

public java.lang.String getCapability()

Description copied from interface: CapabilitiesInterface

Returns the capability string reported by the CAPA command.

Specified by:

getCapability in interface CapabilitiesInterface

Returns:

the capability string