org.apache.james.mailbox.jcr.user.model

Class JCRSubscription

java.lang.Object

org.apache.james.mailbox.jcr.user.model.JCRSubscription

All Implemented Interfaces:

JCRImapConstants, Persistent, Subscription

public class JCRSubscription
extends Object
implements Subscription, Persistent, JCRImapConstants

JCR implementation of a Subscription.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAILBOXES_PROPERTY
static String	USERNAME_PROPERTY

Fields inherited from interface org.apache.james.mailbox.jcr.JCRImapConstants

NODE_DELIMITER

Constructor Summary

Constructors

Constructor and Description
JCRSubscription(javax.jcr.Node node, String mailbox, org.slf4j.Logger log)
JCRSubscription(String username, String mailbox, org.slf4j.Logger log)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getMailbox() Gets the name of the mailbox to which the user is subscribed.
javax.jcr.Node	getNode() Return underlying Node
String	getUser() Gets the name of the subscribed user.
int	hashCode()
boolean	isPersistent() Return if the object is persistent
void	merge(javax.jcr.Node node) Merge the object with the node
String	toString() Renders output suitable for debugging.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

USERNAME_PROPERTY

public static final String USERNAME_PROPERTY

See Also:

Constant Field Values

MAILBOXES_PROPERTY

public static final String MAILBOXES_PROPERTY

See Also:

Constant Field Values

Constructor Detail

JCRSubscription

public JCRSubscription(javax.jcr.Node node,
               String mailbox,
               org.slf4j.Logger log)

JCRSubscription

public JCRSubscription(String username,
               String mailbox,
               org.slf4j.Logger log)

Method Detail

getMailbox

public String getMailbox()

Description copied from interface: Subscription

Gets the name of the mailbox to which the user is subscribed. Note that subscriptions must be maintained beyond the lifetime of a particular instance of a mailbox.

Specified by:

getMailbox in interface Subscription

Returns:

not null

getUser

public String getUser()

Description copied from interface: Subscription

Gets the name of the subscribed user.

Specified by:

getUser in interface Subscription

Returns:

not null

getNode

public javax.jcr.Node getNode()

Description copied from interface: Persistent

Return underlying Node

Specified by:

getNode in interface Persistent

Returns:

node

isPersistent

public boolean isPersistent()

Description copied from interface: Persistent

Return if the object is persistent

Specified by:

isPersistent in interface Persistent

Returns:

true if object is persistent else false

merge

public void merge(javax.jcr.Node node)
           throws javax.jcr.RepositoryException

Description copied from interface: Persistent

Merge the object with the node

Specified by:

merge in interface Persistent

Throws:

javax.jcr.RepositoryException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Renders output suitable for debugging.

Overrides:

toString in class Object

Returns:

output suitable for debugging