|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AuthorityDAO
Method Summary | |
---|---|
void |
addAuthority(java.util.Collection parentNames,
java.lang.String childName)
Add a child authority to the given parent authorities |
void |
addAuthorityToZones(java.lang.String authorityName,
java.util.Set zones)
Add an authority to zones |
boolean |
authorityExists(java.lang.String name)
Test if an authority already exists. |
void |
createAuthority(java.lang.String name,
java.lang.String authorityDisplayName,
java.util.Set authorityZones)
Create an authority. |
void |
deleteAuthority(java.lang.String name)
Delete an authority. |
java.util.Set |
findAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String parentAuthority,
boolean immediate,
java.lang.String displayNamePattern,
java.lang.String zoneName)
Find authorities by display name pattern. |
java.util.Set |
getAllAuthoritiesInZone(java.lang.String zoneName,
org.alfresco.service.cmr.security.AuthorityType type)
Gets the names of all authorities in a zone, optionally filtered by type. |
org.alfresco.query.PagingResults |
getAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String zoneName,
java.lang.String displayNameFilter,
boolean sortByDisplayName,
boolean sortAscending,
org.alfresco.query.PagingRequest pagingRequest)
Get authorities by type and/or zone |
java.lang.String |
getAuthorityDisplayName(java.lang.String authorityName)
Get the display name for an authority |
java.lang.String |
getAuthorityName(org.alfresco.service.cmr.repository.NodeRef authorityRef)
Gets the name for the given authority node |
org.alfresco.service.cmr.repository.NodeRef |
getAuthorityNodeRefOrNull(java.lang.String name)
Get a node ref for the authority if one exists |
java.util.Set |
getAuthorityZones(java.lang.String name)
Gets the name of the zone containing the specified authority. |
java.util.Set |
getContainedAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String parentName,
boolean immediate)
Get contained authorities. |
java.util.Set |
getContainingAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String name,
boolean immediate)
Get the authorities that contain the one given. |
java.util.Set |
getContainingAuthoritiesInZone(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String authority,
java.lang.String zoneName,
AuthorityService.AuthorityFilter filter,
int size)
Get a set of authorities with varying filter criteria |
java.lang.String |
getName(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String shortName)
Create the full identifier for an authority given its short name and type. |
org.alfresco.service.cmr.repository.NodeRef |
getOrCreateZone(java.lang.String zoneName)
Gets or creates an authority zone node with the specified name |
java.util.Set |
getRootAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String zoneName)
Get root authorities |
java.lang.String |
getShortName(java.lang.String name)
Extract the short name of an authority from its full identifier. |
org.alfresco.service.cmr.repository.NodeRef |
getZone(java.lang.String zoneName)
Gets an authority zone node with the specified name |
boolean |
isAuthorityContained(org.alfresco.service.cmr.repository.NodeRef authorityNodeRef,
java.lang.String authorityToFind)
|
void |
removeAuthority(java.lang.String parentName,
java.lang.String childName)
Remove an authority. |
void |
removeAuthorityFromZones(java.lang.String authorityName,
java.util.Set zones)
Remove an authority from zones. |
void |
setAuthorityDisplayName(java.lang.String authorityName,
java.lang.String authorityDisplayName)
Set the display name for an authority |
Method Detail |
---|
void addAuthority(java.util.Collection parentNames, java.lang.String childName)
parentNames
- childName
- void createAuthority(java.lang.String name, java.lang.String authorityDisplayName, java.util.Set authorityZones)
name
- authorityDisplayName
- authorityZones
- void deleteAuthority(java.lang.String name)
name
- java.util.Set getContainedAuthorities(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String parentName, boolean immediate)
type
- parentName
- the name of the containing authorityimmediate
-
boolean isAuthorityContained(org.alfresco.service.cmr.repository.NodeRef authorityNodeRef, java.lang.String authorityToFind)
void removeAuthority(java.lang.String parentName, java.lang.String childName)
parentName
- childName
- java.util.Set getContainingAuthorities(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String name, boolean immediate)
type
- name
- immediate
-
java.util.Set getContainingAuthoritiesInZone(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String authority, java.lang.String zoneName, AuthorityService.AuthorityFilter filter, int size)
type
- authority type or null for all typesauthority
- if non-null, only return those authorities who contain this authorityzoneName
- if non-null, only include authorities in the named zonefilter
- optional callback to apply further filter criteria or nullsize
- if greater than zero, the maximum results to return. The search strategy used is varied depending on this number.
org.alfresco.query.PagingResults getAuthorities(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String zoneName, java.lang.String displayNameFilter, boolean sortByDisplayName, boolean sortAscending, org.alfresco.query.PagingRequest pagingRequest)
type
- zoneName
- displayNameFilter
- sortByDisplayName
- sortAscending
- pagingRequest
-
boolean authorityExists(java.lang.String name)
name
-
org.alfresco.service.cmr.repository.NodeRef getAuthorityNodeRefOrNull(java.lang.String name)
name
-
java.lang.String getAuthorityName(org.alfresco.service.cmr.repository.NodeRef authorityRef)
authorityRef
- authority node
java.lang.String getAuthorityDisplayName(java.lang.String authorityName)
authorityName
-
void setAuthorityDisplayName(java.lang.String authorityName, java.lang.String authorityDisplayName)
authorityName
- authorityDisplayName
- java.util.Set getRootAuthorities(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String zoneName)
type
- zoneName
-
java.util.Set findAuthorities(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String parentAuthority, boolean immediate, java.lang.String displayNamePattern, java.lang.String zoneName)
type
- parentAuthority
- if non-null, will look only for authorities who are a child of the named parentimmediate
- if true
then only search root groups if parentAuthority is null, or immediate children of parentAuthority if it is non-null.displayNamePattern
- zoneName
- - may be null to indicate all zones
java.lang.String getShortName(java.lang.String name)
name
-
java.lang.String getName(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String shortName)
type
- shortName
-
org.alfresco.service.cmr.repository.NodeRef getOrCreateZone(java.lang.String zoneName)
zoneName
- the zone name
org.alfresco.service.cmr.repository.NodeRef getZone(java.lang.String zoneName)
zoneName
- the zone name
java.util.Set getAuthorityZones(java.lang.String name)
name
- the authority long name
null
if the authority does not exist.java.util.Set getAllAuthoritiesInZone(java.lang.String zoneName, org.alfresco.service.cmr.security.AuthorityType type)
zoneName
- the zone nametype
- the authority type to filter by or null
for all authority types
void addAuthorityToZones(java.lang.String authorityName, java.util.Set zones)
authorityName
- zones
- void removeAuthorityFromZones(java.lang.String authorityName, java.util.Set zones)
authorityName
- zones
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |