oracle.search.sdk.crawler
Interface DocumentAcl

public interface DocumentAcl

DocumentAcl is to be used by a crawler plugin to generate Access Control List from a list of access control entities

Field Summary

static int	DN
static int	GROUP
static int	GUID
static int	OWNER
static int	SIMPLE id formats; note: must reference values in IdentityManager
static int	UNKNOWN
static int	USER Principal types; note: must reference values in IdentityManager

Method Summary

void	addDenyPrincipal(java.lang.String id, int format, int idType) Add a LDAP user/group as an ACL principal that have no read privilege
java.lang.String	addDenyPrincipal(java.lang.String id, int idType, int format, int targetFormat) Add a LDAP user/group as an ACL principal denied read privilege.
void	addPrincipal(java.lang.String id, int format, int idType) Add a LDAP user/group as an ACL principal that have read privilege
java.lang.String	addPrincipal(java.lang.String id, int idType, int format, int targetFormat) Add a LDAP user/group as an ACL principal with read privilege.
void	clearPrincipalList() Clear all principal data

Field Detail

UNKNOWN

public static final int UNKNOWN

USER

public static final int USER

Principal types; note: must reference values in IdentityManager

GROUP

public static final int GROUP

OWNER

public static final int OWNER

See Also:

Constant Field Values

SIMPLE

public static final int SIMPLE

id formats; note: must reference values in IdentityManager

DN

public static final int DN

GUID

public static final int GUID

Method Detail

addPrincipal

public void addPrincipal(java.lang.String id,
                         int format,
                         int idType)

Add a LDAP user/group as an ACL principal that have read privilege

Parameters:

id - the id of the principal

format - the format of the principal entry: DN, GUID

idType - id type: USER, GROUP, OWNER, UNKNOWN

addPrincipal

public java.lang.String addPrincipal(java.lang.String id,
                                     int idType,
                                     int format,
                                     int targetFormat)

Add a LDAP user/group as an ACL principal with read privilege.

Parameters:

id - the id of the principal

idType - id type: USER, GROUP, OWNER, UNKNOWN

format - the format of the principal entry: DN, GUID

targetFormat - the target format of the principal entry: DN, GUID

Returns:

principal inserted; if principal validation if triggered and principal does not exist, then null is returned and principal is not inserted into the ACL.

addDenyPrincipal

public void addDenyPrincipal(java.lang.String id,
                             int format,
                             int idType)

Add a LDAP user/group as an ACL principal that have no read privilege

Parameters:

id - the id of the principal

format - the format of the principal entry; can be AclHelper.DN or AclHelper.GUID

idType - USER, GROUP,OWNER, or UNKNOWN

addDenyPrincipal

public java.lang.String addDenyPrincipal(java.lang.String id,
                                         int idType,
                                         int format,
                                         int targetFormat)

Add a LDAP user/group as an ACL principal denied read privilege.

Parameters:

id - the id of the principal

idType - id type: USER, GROUP, OWNER, UNKNOWN

format - the format of the principal entry: DN, GUID

targetFormat - the target format of the principal entry: DN, GUID

Returns:

principal inserted; if principal validation if triggered and principal does not exist, then null is returned and principal is not inserted into the ACL.

clearPrincipalList

public void clearPrincipalList()

Clear all principal data