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

Interface StatusResponseFactory

All Known Implementing Classes:

AbstactStatusResponseFactory, UnpooledStatusResponseFactory

public interface StatusResponseFactory

Constructs StatusResponse instances. This interface enforces RFC2060 rules.

Method Summary

Methods

Modifier and Type	Method and Description
StatusResponse	bye(HumanReadableText displayTextKey) Creates a BYE status response.
StatusResponse	bye(HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a BYE status response.
StatusResponse	preauth(HumanReadableText displayTextKey) Creates a PREAUTH status response.
StatusResponse	preauth(HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a PREAUTH status response.
StatusResponse	taggedBad(String tag, ImapCommand command, HumanReadableText displayTextKey) Creates a tagged BAD status response.
StatusResponse	taggedBad(String tag, ImapCommand command, HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a tagged BAD status response.
StatusResponse	taggedNo(String tag, ImapCommand command, HumanReadableText displayTextKey) Creates a tagged NO status response.
StatusResponse	taggedNo(String tag, ImapCommand command, HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a tagged NO status response.
StatusResponse	taggedOk(String tag, ImapCommand command, HumanReadableText displayTextKey) Creates a tagged OK status response.
StatusResponse	taggedOk(String tag, ImapCommand command, HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a tagged OK status response.
StatusResponse	untaggedBad(HumanReadableText displayTextKey) Creates a untagged BAD status response.
StatusResponse	untaggedBad(HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a untagged BAD status response.
StatusResponse	untaggedNo(HumanReadableText displayTextKey) Creates a untagged NO status response.
StatusResponse	untaggedNo(HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a untagged NO status response.
StatusResponse	untaggedOk(HumanReadableText displayTextKey) Creates a untagged OK status response.
StatusResponse	untaggedOk(HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a untagged OK status response.

Method Detail

taggedOk

StatusResponse taggedOk(String tag,
                      ImapCommand command,
                      HumanReadableText displayTextKey,
                      StatusResponse.ResponseCode code)

Creates a tagged OK status response.

Parameters:

tag - operation tag, not null

command - ImapCommand, not null

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

taggedNo

StatusResponse taggedNo(String tag,
                      ImapCommand command,
                      HumanReadableText displayTextKey,
                      StatusResponse.ResponseCode code)

Creates a tagged NO status response.

Parameters:

tag - CharSequence, not null

command - ImapCommand, not null

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

taggedBad

StatusResponse taggedBad(String tag,
                       ImapCommand command,
                       HumanReadableText displayTextKey,
                       StatusResponse.ResponseCode code)

Creates a tagged BAD status response.

Parameters:

tag - CharSequence, not null

command - ImapCommand, not null

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

untaggedOk

StatusResponse untaggedOk(HumanReadableText displayTextKey,
                        StatusResponse.ResponseCode code)

Creates a untagged OK status response.

Parameters:

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

untaggedNo

StatusResponse untaggedNo(HumanReadableText displayTextKey,
                        StatusResponse.ResponseCode code)

Creates a untagged NO status response.

Parameters:

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

untaggedBad

StatusResponse untaggedBad(HumanReadableText displayTextKey,
                         StatusResponse.ResponseCode code)

Creates a untagged BAD status response.

Parameters:

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

preauth

StatusResponse preauth(HumanReadableText displayTextKey,
                     StatusResponse.ResponseCode code)

Creates a PREAUTH status response. These are always untagged.

Parameters:

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

bye

StatusResponse bye(HumanReadableText displayTextKey,
                 StatusResponse.ResponseCode code)

Creates a BYE status response. These are always untagged.

Parameters:

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

taggedOk

StatusResponse taggedOk(String tag,
                      ImapCommand command,
                      HumanReadableText displayTextKey)

Creates a tagged OK status response.

Parameters:

tag - CharSequence, not null

command - ImapCommand, not null

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

taggedNo

StatusResponse taggedNo(String tag,
                      ImapCommand command,
                      HumanReadableText displayTextKey)

Creates a tagged NO status response.

Parameters:

tag - CharSequence, not null

command - ImapCommand, not null

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

taggedBad

StatusResponse taggedBad(String tag,
                       ImapCommand command,
                       HumanReadableText displayTextKey)

Creates a tagged BAD status response.

Parameters:

tag - CharSequence, not null

command - ImapCommand, not null

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

untaggedOk

StatusResponse untaggedOk(HumanReadableText displayTextKey)

Creates a untagged OK status response.

Parameters:

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

untaggedNo

StatusResponse untaggedNo(HumanReadableText displayTextKey)

Creates a untagged NO status response.

Parameters:

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

untaggedBad

StatusResponse untaggedBad(HumanReadableText displayTextKey)

Creates a untagged BAD status response.

Parameters:

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

preauth

StatusResponse preauth(HumanReadableText displayTextKey)

Creates a PREAUTH status response. These are always untagged.

Parameters:

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

bye

StatusResponse bye(HumanReadableText displayTextKey)

Creates a BYE status response. These are always untagged.

Parameters:

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null