Skip navigation links

oracle.search.sdk.crawler
Interface DocumentAcl

public interface DocumentAcl

DocumentAcl is used by a crawler plug-in to generate an Access Control List from a list of access control entries or to store security attribute value data.

Field Summary

static int	DN Deprecated.
static int	GROUP Group principal type
static int	GUID Deprecated.
static int	OWNER Owner principal type
static int	SIMPLE Deprecated.
static int	UNKNOWN Unknown principal type, indicating either USER or GROUP
static int	USER User principal type

Method Summary

void	addDenyPrincipal(String id, int format, int idType) Deprecated.
String	addDenyPrincipal(String id, int idType, int format, int targetFormat) Deprecated.
void	addDenyPrincipal(String id, String format, int idType) Adds an LDAP user/group as an ACL principal that has no read privileges.
void	addPrincipal(String id, int format, int idType) Deprecated.
String	addPrincipal(String id, int idType, int format, int targetFormat) Deprecated.
void	addPrincipal(String id, String format, int idType) Adds an LDAP user/group as an ACL principal that has read privileges.
void	addSecurityAttribute(String name, String value) Adds a security attribute value.
void	clearPrincipalList() Clears all principal data.
void	clearSecurityAttributes() Clears all security attribute value data.
String	toString() Converts current ACL or security attribute data into a String.

Field Detail

UNKNOWN

public static final int UNKNOWN

Unknown principal type, indicating either USER or GROUP

See Also:

Constant Field Values

USER

public static final int USER

User principal type

See Also:

Constant Field Values

GROUP

public static final int GROUP

Group principal type

See Also:

Constant Field Values

OWNER

public static final int OWNER

Owner principal type

See Also:

Constant Field Values

SIMPLE

public static final int SIMPLE

Deprecated.

Simple ID format

See Also:

Constant Field Values

DN

public static final int DN

Deprecated.

DN ID format

See Also:

Constant Field Values

GUID

public static final int GUID

Deprecated.

GUID ID format

See Also:

Constant Field Values

Method Detail

addPrincipal

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

Adds an LDAP user/group as an ACL principal that has read privileges.

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, or UNKNOWN (USER or GROUP). Any other value is treated as UNKNOWN.

Throws:

ProcessingException

addDenyPrincipal

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

Adds an LDAP user/group as an ACL principal that has no read privileges.

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, or UNKNOWN (USER or GROUP). Any other value is treated as UNKNOWN.

Throws:

ProcessingException

addPrincipal

public void addPrincipal(String id,
                         int format,
                         int idType)

Deprecated.

Adds an LDAP user/group as an ACL principal that has read privileges.

Parameters:

id - the id of the principal

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

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

addPrincipal

public String addPrincipal(String id,
                           int idType,
                           int format,
                           int targetFormat)

Deprecated.

Adds an LDAP user/group as an ACL principal with read privileges.

Parameters:

id - the id of the principal

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

format - the format of the principal entry: DN or GUID.

targetFormat - the target format of the principal entry: DN or GUID.

Returns:

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

addDenyPrincipal

public void addDenyPrincipal(String id,
                             int format,
                             int idType)

Deprecated.

Adds an LDAP user/group as an ACL principal that has no read privileges.

Parameters:

id - the id of the principal

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

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

addDenyPrincipal

public String addDenyPrincipal(String id,
                               int idType,
                               int format,
                               int targetFormat)

Deprecated.

Adds an LDAP user/group as an ACL principal denied read privileges.

Parameters:

id - the id of the principal

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

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

targetFormat - the target format of the principal entry: DN or 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()

Clears all principal data.

addSecurityAttribute

public void addSecurityAttribute(String name,
                                 String value)
                          throws ProcessingException

Adds a security attribute value.

Parameters:

name - the name of the security attribute

value - security attribute value

Throws:

ProcessingException - If the source is using identity-based security, if the name is null or not in the list of security attributes defined by the crawler plug-in, or if the value is null, zero-length, or longer than 200 characters.

clearSecurityAttributes

public void clearSecurityAttributes()

Clears all security attribute value data.

toString

public String toString()

Converts 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