org.xwiki.security

Interface SecurityReferenceFactory

All Known Implementing Classes:

DefaultSecurityReferenceFactory

@Role
public interface SecurityReferenceFactory

Factory to create new SecurityReference, UserSecurityReference and GroupSecurityReference.

Since:

4.0M2

Version:

$Id: c58a6d2797d9019349e54b60d9c5bab54c7bdd4d $

Method Summary

Methods

Modifier and Type	Method and Description
SecurityReference	newEntityReference(EntityReference reference) Returns a SecurityReference for the provided entity.
GroupSecurityReference	newGroupReference(DocumentReference reference) Returns a GroupSecurityReference for the provided group document reference.
UserSecurityReference	newUserReference(DocumentReference reference) Returns a UserSecurityReference for the provided user document reference.

Method Detail

newEntityReference

SecurityReference newEntityReference(EntityReference reference)

Returns a SecurityReference for the provided entity.

Parameters:

reference - the entity reference to clone

Returns:

a SecurityReference for the provided entity.

newUserReference

UserSecurityReference newUserReference(DocumentReference reference)

Returns a UserSecurityReference for the provided user document reference.

Parameters:

reference - the entity reference to clone

Returns:

a UserSecurityReference for the provided user document reference.

newGroupReference

GroupSecurityReference newGroupReference(DocumentReference reference)

Returns a GroupSecurityReference for the provided group document reference.

Parameters:

reference - the entity reference to clone

Returns:

a GroupSecurityReference for the provided group document reference.