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 or 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 the current ACL or security attribute data into a String.

Field Detail

UNKNOWN

static final int UNKNOWN

Unknown principal type, indicating either USER or GROUP

See Also:

Constant Field Values

USER

static final int USER

User principal type

See Also:

Constant Field Values

GROUP

static final int GROUP

Group principal type

See Also:

Constant Field Values

OWNER

static final int OWNER

Owner principal type

See Also:

Constant Field Values

SIMPLE

static final int SIMPLE

Deprecated.

Simple ID format

See Also:

Constant Field Values

DN

static final int DN

Deprecated.

DN ID format

See Also:

Constant Field Values

GUID

static final int GUID

Deprecated.

GUID ID format

See Also:

Constant Field Values

Method Detail

addPrincipal

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

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

Parameters:

id - ID of the principal

format - Format of the principal entry, which 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

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 - ID of the principal

format - Format of the principal entry, which 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

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

Deprecated.

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

Parameters:

id - ID of the principal

format - Format of the principal entry. DN, GUID, or SIMPLE

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

addPrincipal

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

Deprecated.

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

Parameters:

id - ID of the principal

idType - ID type: USER, GROUP, OWNER, or UNKNOWN

format - Format of the principal entry: DN or GUID

targetFormat - Target format of the principal entry: DN or GUID

Returns:

The inserted principal. If principal validation is triggered and the principal does not exist, then it returns null and does not insert the principal into the ACL.

addDenyPrincipal

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

Deprecated.

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

Parameters:

id - ID of the principal

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

idType - ID type: USER, GROUP, OWNER, or UNKNOWN

addDenyPrincipal

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

Deprecated.

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

Parameters:

id - ID of the principal

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

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

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

Returns:

The inserted principal. If principal validation is triggered and principal does not exist, then it returns null and does not insert the principal into the ACL.

clearPrincipalList

void clearPrincipalList()

Clears all principal data.

addSecurityAttribute

void addSecurityAttribute(String name,
                          String value)
                          throws ProcessingException

Adds a security attribute value.

Parameters:

name - 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

void clearSecurityAttributes()

Clears all security attribute value data.

toString

String toString()

Converts the current ACL or security attribute data into a String.

Overrides:

toString in class Object

Returns:

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

Skip navigation links