org.apache.jackrabbit.webdav.security

Class Principal

java.lang.Object

org.apache.jackrabbit.webdav.security.Principal

All Implemented Interfaces:

SecurityConstants, XmlSerializable

public class Principal
extends Object
implements XmlSerializable, SecurityConstants

Principal encapsulates the DAV:principal element which identifies the principal to which this ACE applies. RFC 3744 defines the following structure for this element:

 <!ELEMENT principal (href | all | authenticated | unauthenticated | property | self)>
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	XML_PRINCIPAL

Fields inherited from interface org.apache.jackrabbit.webdav.security.SecurityConstants

ACL, ACL_RESTRICTIONS, ALTERNATE_URI_SET, CURRENT_USER_PRIVILEGE_SET, GROUP, GROUP_MEMBER_SET, GROUP_MEMBERSHIP, INHERITED_ACL_SET, NAMESPACE, OWNER, PRINCIPAL_COLLECTION_SET, PRINCIPAL_RESOURCETYPE, PRINCIPAL_URL, SUPPORTED_PRIVILEGE_SET

Method Summary

Modifier and Type	Method and Description
static Principal	createFromXml(Element principalElement)
static Principal	getAllPrincipal()
static Principal	getAuthenticatedPrincipal()
String	getHref()
static Principal	getHrefPrincipal(String href)
DavPropertyName	getPropertyName()
static Principal	getPropertyPrincipal(DavPropertyName propertyName)
static Principal	getSelfPrincipal()
static Principal	getUnauthenticatedPrincipal()
Element	toXml(Document document) Returns the xml representation of the implementing object as Element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XML_PRINCIPAL

public static final String XML_PRINCIPAL

See Also:

Constant Field Values

Method Detail

getHref

public String getHref()

Returns:

href if this Principal is a href-typed principal, null otherwise.

getPropertyName

public DavPropertyName getPropertyName()

Returns:

propertyName if this Principal is a property-principal, null otherwise.

toXml

public Element toXml(Document document)

Description copied from interface: XmlSerializable

Returns the xml representation of the implementing object as Element. The given Document is used as factory and represents the owner document of the returned DOM element.

Specified by:

toXml in interface XmlSerializable

Parameters:

document - to be used as factory.

Returns:

a w3c element representing this object

See Also:

XmlSerializable.toXml(Document)

getAllPrincipal

public static Principal getAllPrincipal()

getAuthenticatedPrincipal

public static Principal getAuthenticatedPrincipal()

getUnauthenticatedPrincipal

public static Principal getUnauthenticatedPrincipal()

getSelfPrincipal

public static Principal getSelfPrincipal()

getPropertyPrincipal

public static Principal getPropertyPrincipal(DavPropertyName propertyName)

getHrefPrincipal

public static Principal getHrefPrincipal(String href)

createFromXml

public static Principal createFromXml(Element principalElement)
                               throws DavException

Throws:

DavException