javax.wvcm
Interface Principal

All Superinterfaces:
Resource
All Known Subinterfaces:
Principal.Group, Principal.Role
All Known Implementing Classes:
Principal.GenericPrincipalImpl, PrincipalImpl, PrincipalImpl.GroupImpl, PrincipalImpl.RoleImpl

public interface Principal
extends Resource

NOT YET STANDARD

A "principal" is a distinct human or computational actor that initiates access to network resources. In this protocol, a principal is an HTTP resource that represents such an actor.

See section 2 of RFCxxxx (WebDAV ACL).


Nested Class Summary
static class Principal.GenericPrincipalImpl
          NOT YET STANDARD Implementation of a generic Principal.
static interface Principal.Group
          NOT YET STANDARD A "group" is a principal that represents a set of other principals.
static interface Principal.Role
          NOT YET STANDARD A "role" is a principal that represents a set of other principals.
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.GenericResourceImpl
 
Field Summary
static Principal ALL
           
static Principal AUTHENTICATED
           
static Principal OWNER
           
static Principal SELF
           
static Principal UNAUTHENTICATED
           
 
Method Summary
 void doCreateResource()
          Create a Principal on the server.
 java.util.List getGroupMembership()
          Get the list of groups (Principal.Group) in which the principal is directly a member.
 
Methods inherited from interface javax.wvcm.Resource
doBind, doCopy, doLock, doLock, doReadAccessControlList, doReadContent, doReadProperties, doRebind, doSearch, doUnbind, doUnlock, doUnlock, doWriteAccessControlList, doWriteContent, doWriteProperties, getAttribute, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreationUser, getCreatorDisplayName, getDisplayName, getLastModified, getLockTokens, getModificationDate, getModificationUser, getOwner, getParentBindingList, getPrincipalFolderList, getPrivilegeFolderList, getProperty, getPropertyNameList, getProviderList, getResourceIdentifier, getSupportedPrivilegeList, getUpdatedPropertyList, getWorkspaceFolderList, location, removeAttribute, setAttribute, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName, setProperty
 

Field Detail

ALL

static final Principal ALL

SELF

static final Principal SELF

OWNER

static final Principal OWNER

AUTHENTICATED

static final Principal AUTHENTICATED

UNAUTHENTICATED

static final Principal UNAUTHENTICATED
Method Detail

doCreateResource

void doCreateResource()
                      throws WvcmException
Create a Principal on the server.

Throws:
WvcmException - Preconditions:
(resource-must-be-null): A resource MUST NOT exist at the location of this Resource.
(location-ok): The location of this Principal MUST identify a valid location to create this Resource. A client can determine the location of folders that can contain principals from the PrincipalFolderList property.
WvcmException - Postconditions:
(initialize-resource): A new Principal resource exists at the location of this Resource.

getGroupMembership

java.util.List getGroupMembership()
                                  throws WvcmException
Get the list of groups (Principal.Group) in which the principal is directly a member.

Returns:
a List
Throws:
WvcmException - if this principal was not created with PropertyNameList.PropertyName.GROUP_MEMBERSHIP as a wanted property


Copyright (c) 2003 - Apache Software Foundation