org.apache.james.imap.processor

Interface PermitEnableCapabilityProcessor

All Superinterfaces:

CapabilityImplementingProcessor, ImapProcessor

All Known Implementing Classes:

ExamineProcessor, SelectProcessor

public interface PermitEnableCapabilityProcessor
extends CapabilityImplementingProcessor

CapabilityImplementingProcessor which allows to ENABLE one ore more Capabilities

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PermitEnableCapabilityProcessor.EnableException Exception which should get thrown if for whatever reason its not possible to enable a capability

Nested classes/interfaces inherited from interface org.apache.james.imap.api.process.ImapProcessor

ImapProcessor.Responder

Method Summary

Methods

Modifier and Type	Method and Description
void	enable(ImapMessage message, ImapProcessor.Responder responder, ImapSession session, String capability) Callback which is used when a ENABLED command was used to enable on of the CAPABILITIES which is managed by this implementation
List<String>	getPermitEnableCapabilities(ImapSession session) Return the capabilities which supports to get ENABLED.

Methods inherited from interface org.apache.james.imap.processor.CapabilityImplementingProcessor

getImplementedCapabilities

Methods inherited from interface org.apache.james.imap.api.process.ImapProcessor

process

Method Detail

getPermitEnableCapabilities

List<String> getPermitEnableCapabilities(ImapSession session)

Return the capabilities which supports to get ENABLED. Be sure that these are also returned by CapabilityImplementingProcessor.getImplementedCapabilities(ImapSession)

Parameters:

session -

Returns:

permitCaps

enable

void enable(ImapMessage message,
          ImapProcessor.Responder responder,
          ImapSession session,
          String capability)
            throws PermitEnableCapabilityProcessor.EnableException

Callback which is used when a ENABLED command was used to enable on of the CAPABILITIES which is managed by this implementation

Parameters:

message -

responder -

session -

capability -

Throws:

PermitEnableCapabilityProcessor.EnableException