com.centrasite.jaxr.security
Interface CentraSitePrincipal


public interface CentraSitePrincipal

A CentraSitePrincipal represents the principal information of a CentraSiteACE. It corresponds to a WebDAV Principal element. A CentraSitePrincipal is either
- a href representing a user or a group, or
- a "all" indicator, or
- a "authenticated" indicator, or
- a "unauthenticated" indicator.
WebDAV also has "property" and "self" attributes, and a WebDAV principal may be inverted, however the current CentraSite XML server does not support this.


Field Summary
static javax.xml.namespace.QName ALL
          Indicate a CentraSitePrincipal with the "all" indicator set.
static javax.xml.namespace.QName AUTHENTICATED
          Indicate a CentraSitePrincipal with the "authenticated" indicator set.
static javax.xml.namespace.QName UNAUTHENTICATED
          Indicate a CentraSitePrincipal with the "unauthenticated" indicator set.
 
Method Summary
 java.lang.String getHref()
          get the href.
 boolean isAll()
          get the "all" indicator.
 boolean isAuthenticated()
          get the "authenticated" indicator.
 boolean isUnauthenticated()
          get the "unauthenticated" indicator.
 void setAll()
          set the "all" indicator.
 void setAuthenticated()
          set the "authenticated" indicator.
 void setHref(java.lang.String href)
          Set the href.
 void setOwnerObject(java.lang.Object owner)
          set this CentraSitePrincipal's owner object
 void setUnauthenticated()
          set the "unauthenticated" indicator.
 

Field Detail

ALL

static final javax.xml.namespace.QName ALL
Indicate a CentraSitePrincipal with the "all" indicator set.


AUTHENTICATED

static final javax.xml.namespace.QName AUTHENTICATED
Indicate a CentraSitePrincipal with the "authenticated" indicator set.


UNAUTHENTICATED

static final javax.xml.namespace.QName UNAUTHENTICATED
Indicate a CentraSitePrincipal with the "unauthenticated" indicator set.

Method Detail

setHref

void setHref(java.lang.String href)
             throws javax.xml.registry.JAXRException
Set the href. The href needs to be an absolute URI or one with a path starting '/'.

Parameters:
href - the href
Throws:
javax.xml.registry.JAXRException - if href is an invalid URI

getHref

java.lang.String getHref()
get the href.

Returns:
the href

setAll

void setAll()
set the "all" indicator.


isAll

boolean isAll()
get the "all" indicator.

Returns:
true if the "all" indicator is set

setAuthenticated

void setAuthenticated()
set the "authenticated" indicator.


isAuthenticated

boolean isAuthenticated()
get the "authenticated" indicator.

Returns:
true if the "authenticated" indicator is set

setUnauthenticated

void setUnauthenticated()
set the "unauthenticated" indicator.


isUnauthenticated

boolean isUnauthenticated()
get the "unauthenticated" indicator.

Returns:
true if the "unauthenticated" indicator is set

setOwnerObject

void setOwnerObject(java.lang.Object owner)
set this CentraSitePrincipal's owner object

Parameters:
owner - this CentraSitePrincipal's owner object, maybe null