Skip navigation links

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) Deprecated.
java.lang.String	addDenyPrincipal(java.lang.String id, int idType, int format, int targetFormat) Deprecated.
void	addDenyPrincipal(java.lang.String id, java.lang.String format, int idType) Add a LDAP user/group as an ACL principal that has no read privilege
void	addPrincipal(java.lang.String id, int format, int idType) Deprecated.
java.lang.String	addPrincipal(java.lang.String id, int idType, int format, int targetFormat) Deprecated.
void	addPrincipal(java.lang.String id, java.lang.String format, int idType) Add a LDAP user/group as an ACL principal that has read privilege
void	addSecurityAttribute(java.lang.String name, java.lang.String value) Add a security attribute value
void	clearPrincipalList() Clear all principal data
void	clearSecurityAttributes() Clear all security attribute data
java.lang.String	toString() covert current ACL or security attribute data into a string

Field Detail

UNKNOWN

public static final int UNKNOWN

See Also:

Constant Field Values

USER

public static final int USER

Principal types; note: must reference values in IdentityManager

See Also:

Constant Field Values

GROUP

public static final int GROUP

See Also:

Constant Field Values

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

See Also:

Constant Field Values

DN

public static final int DN

See Also:

Constant Field Values

GUID

public static final int GUID

See Also:

Constant Field Values

Method Detail

addPrincipal

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

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

Parameters:

id - the id of the principal

format - the format of the principal entry; should be recognizable by the corresponding identity plug-in

idType - id type: USER, GROUP, UNKNOWN(USER or GROUP). Any other value is treated as UNKNOWN

Throws:

ProcessingException

addDenyPrincipal

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

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

Parameters:

id - the id of the principal

format - the format of the principal entry; should be recognizable by the corresponding identity plug-in

idType - id type: USER, GROUP, UNKNOWN(USER or GROUP). Any other value is treated as UNKNOWN

Throws:

ProcessingException

addPrincipal

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

Deprecated.

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; can be DocumentAcl.DN, DocumentAcl.GUID, or DocumentAcl.SIMPLE

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

addPrincipal

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

Deprecated.

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)

Deprecated.

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 DocumentAcl.DN or DocumentAcl.GUID, or DocumentAcl.SIMPLE

idType - USER, GROUP,OWNER, or UNKNOWN

addDenyPrincipal

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

Deprecated.

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

addSecurityAttribute

public void addSecurityAttribute(java.lang.String name,
                                 java.lang.String value)
                          throws ProcessingException

Add a security attribute value

Parameters:

name - the name of the security attribute

value - attribute value; must be less than 51 bytes and character in A-Z, 0-9

Throws:

ProcessingException

clearSecurityAttributes

public void clearSecurityAttributes()

Clear all security attribute data

toString

public java.lang.String toString()

covert current ACL or security attribute data into a string

Returns:

the ACL string if it is identity-based, the security attribute data string if it is user-defined security

Skip navigation links