org.apache.james.imap.api.message.response

Interface StatusResponse

All Superinterfaces:

ImapMessage, ImapResponseMessage

All Known Implementing Classes:

ImmutableStatusResponse

public interface StatusResponse
extends ImapResponseMessage

Represents an RFC2060 status response. The five specified status server responses (OK. NO, BAD, PREAUTH and BYE) are modeled by this single interface. They are differentiated by getServerResponseType()

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StatusResponse.ResponseCode Enumerates response codes.
static class	StatusResponse.Type Enumerates types of RC2060 status response

Method Summary

Methods

Modifier and Type	Method and Description
ImapCommand	getCommand() Gets the command.
StatusResponse.ResponseCode	getResponseCode() Gets the response code.
StatusResponse.Type	getServerResponseType() Gets the server response type of this status message.
String	getTag() Gets the tag.
HumanReadableText	getTextKey() Gets the key to the human readable text to be displayed.

Method Detail

getServerResponseType

StatusResponse.Type getServerResponseType()

Gets the server response type of this status message.

Returns:

The type, either StatusResponse.Type.BAD, StatusResponse.Type.BYE, StatusResponse.Type.NO, StatusResponse.Type.OK or StatusResponse.Type.PREAUTH

getTag

String getTag()

Gets the tag.

Returns:

if tagged response, the tag. Otherwise null.

getCommand

ImapCommand getCommand()

Gets the command.

Returns:

if tagged response, the command. Otherwise null

getTextKey

HumanReadableText getTextKey()

Gets the key to the human readable text to be displayed. Required.

Returns:

key for the text message to be displayed, not null

getResponseCode

StatusResponse.ResponseCode getResponseCode()

Gets the response code. Optional.

Returns:

ResponseCode, or null if there is no response code