wt.inf.container
Class PrincipalSpec

java.lang.Object
  wt.inf.container.PrincipalSpec

All Implemented Interfaces:

Cloneable, Serializable

public final class PrincipalSpec

extends Object

implements Cloneable, Serializable

Used to configure the set of DirectoryContextProviders returned by WTContainerService.getPublicContextProviders(PrincipalSpec).

Supported API: false

Extendable: false

See Also:

wt#org#DirectoryContextProvider, Serialized Form

Field Summary

private static String	CLASSNAME
private WTContainerRef	containerReference
private boolean	filterByOrganization
private boolean	includeAllServices
private boolean	includeOrganizations
private boolean	performLookup
private Class	principalClass
private static String	RESOURCE
private boolean	restrictedDirectorySearchScope
private String	searchCriteria
private int	sizeLimit

Constructor Summary

PrincipalSpec()


Supported API: false

PrincipalSpec(WTContainerRef container_reference)


Supported API: false

PrincipalSpec(WTContainerRef container_reference, Class principal_class)


Supported API: false

Method Summary

Object	clone() Supported API: false
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
WTContainer	getContainer() Supported API: false
WTContainerRef	getContainerReference() Gets the value of the attribute: containerReference; The container to search for principals in.
Class	getPrincipalClass() Gets the value of the attribute: principalClass; The class of WTPrincipal to search for.
String	getSearchCriteria() Gets the value of the attribute: searchCriteria; A set of search conditions to filter the query by, such as: String criteria = "(" + WTUser.NAME + "=Smith" & " + WTUser.ORGANIZATION + "=PTC)"; Supported API: false
int	getSizeLimit() Gets the value of the attribute: sizeLimit; The maximum number of results to return.
boolean	isFilterByOrganization() Gets the value of the attribute: filterByOrganization; When true, queries for users are filtered by the organization associated with the spec's containerReference Default: false Supported API: false
boolean	isIncludeAllServices() Gets the value of the attribute: includeAllServices; When true, all known services are queried.
boolean	isIncludeOrganizations() Gets the value of the attribute: includeOrganizations; Whether or not the query result should include WTOrganizations.
boolean	isPerformLookup() Gets the value of the attribute: performLookup; When true, queries for groups include contexts from parent containers.
boolean	isRestrictedDirectorySearchScope() Gets the value of the attribute: restrictedDirectorySearchScope; Specifies that the directory search should be restricted, as if the OrgContainer.restrictedDirectorySearchScope were true.
private void	searchCriteriaValidate(String a_SearchCriteria)
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: containerReference; The container to search for principals in.
void	setFilterByOrganization(boolean a_FilterByOrganization) Sets the value of the attribute: filterByOrganization; When true, queries for users are filtered by the organization associated with the spec's containerReference Default: false Supported API: false
void	setIncludeAllServices(boolean a_IncludeAllServices) Sets the value of the attribute: includeAllServices; When true, all known services are queried.
void	setIncludeOrganizations(boolean a_IncludeOrganizations) Sets the value of the attribute: includeOrganizations; Whether or not the query result should include WTOrganizations.
void	setPerformLookup(boolean a_PerformLookup) Sets the value of the attribute: performLookup; When true, queries for groups include contexts from parent containers.
void	setPrincipalClass(Class a_PrincipalClass) Sets the value of the attribute: principalClass; The class of WTPrincipal to search for.
void	setRestrictedDirectorySearchScope(boolean a_RestrictedDirectorySearchScope) Sets the value of the attribute: restrictedDirectorySearchScope; Specifies that the directory search should be restricted, as if the OrgContainer.restrictedDirectorySearchScope were true.
void	setSearchCriteria(String a_SearchCriteria) Sets the value of the attribute: searchCriteria; A set of search conditions to filter the query by, such as: String criteria = "(" + WTUser.NAME + "=Smith" & " + WTUser.ORGANIZATION + "=PTC)"; Supported API: false
void	setSizeLimit(int a_SizeLimit) Sets the value of the attribute: sizeLimit; The maximum number of results to return.
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

containerReference

private WTContainerRef containerReference

filterByOrganization

private boolean filterByOrganization

includeAllServices

private boolean includeAllServices

includeOrganizations

private boolean includeOrganizations

performLookup

private boolean performLookup

principalClass

private Class principalClass

restrictedDirectorySearchScope

private boolean restrictedDirectorySearchScope

searchCriteria

private String searchCriteria

sizeLimit

private int sizeLimit

Constructor Detail

PrincipalSpec

public PrincipalSpec()

Supported API: false

PrincipalSpec

public PrincipalSpec(WTContainerRef container_reference)
              throws WTException

Supported API: false

Parameters:

container_reference -

Throws:

WTException

PrincipalSpec

public PrincipalSpec(WTContainerRef container_reference,
                     Class principal_class)
              throws WTException

Supported API: false

Parameters:

container_reference -

principal_class -

Throws:

WTException

Method Detail

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: containerReference; The container to search for principals in.
Default: The site container.

Supported API: false

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: containerReference; The container to search for principals in.
Default: The site container.

Supported API: false

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

isFilterByOrganization

public boolean isFilterByOrganization()

Gets the value of the attribute: filterByOrganization; When true, queries for users are filtered by the organization associated with the spec's containerReference
Default: false

Supported API: false

Returns:

boolean

setFilterByOrganization

public void setFilterByOrganization(boolean a_FilterByOrganization)
                             throws WTPropertyVetoException

Sets the value of the attribute: filterByOrganization; When true, queries for users are filtered by the organization associated with the spec's containerReference
Default: false

Supported API: false

Parameters:

a_FilterByOrganization -

Throws:

WTPropertyVetoException

isIncludeAllServices

public boolean isIncludeAllServices()

Gets the value of the attribute: includeAllServices; When true, all known services are queried. When false, only the bundled adapter is queried.
Default: true

Supported API: false

Returns:

boolean

setIncludeAllServices

public void setIncludeAllServices(boolean a_IncludeAllServices)
                           throws WTPropertyVetoException

Sets the value of the attribute: includeAllServices; When true, all known services are queried. When false, only the bundled adapter is queried.
Default: true

Supported API: false

Parameters:

a_IncludeAllServices -

Throws:

WTPropertyVetoException

isIncludeOrganizations

public boolean isIncludeOrganizations()

Gets the value of the attribute: includeOrganizations; Whether or not the query result should include WTOrganizations.

Supported API: false

Returns:

boolean

setIncludeOrganizations

public void setIncludeOrganizations(boolean a_IncludeOrganizations)
                             throws WTPropertyVetoException

Sets the value of the attribute: includeOrganizations; Whether or not the query result should include WTOrganizations.

Supported API: false

Parameters:

a_IncludeOrganizations -

Throws:

WTPropertyVetoException

isPerformLookup

public boolean isPerformLookup()

Gets the value of the attribute: performLookup; When true, queries for groups include contexts from parent containers.
Default: true

Supported API: false

Returns:

boolean

setPerformLookup

public void setPerformLookup(boolean a_PerformLookup)
                      throws WTPropertyVetoException

Sets the value of the attribute: performLookup; When true, queries for groups include contexts from parent containers.
Default: true

Supported API: false

Parameters:

a_PerformLookup -

Throws:

WTPropertyVetoException

getPrincipalClass

public Class getPrincipalClass()

Gets the value of the attribute: principalClass; The class of WTPrincipal to search for.
Default: WTGroup

Supported API: false

Returns:

Class

setPrincipalClass

public void setPrincipalClass(Class a_PrincipalClass)
                       throws WTPropertyVetoException

Sets the value of the attribute: principalClass; The class of WTPrincipal to search for.
Default: WTGroup

Supported API: false

Parameters:

a_PrincipalClass -

Throws:

WTPropertyVetoException

isRestrictedDirectorySearchScope

public boolean isRestrictedDirectorySearchScope()

Gets the value of the attribute: restrictedDirectorySearchScope; Specifies that the directory search should be restricted, as if the OrgContainer.restrictedDirectorySearchScope were true.

Supported API: false

Returns:

boolean

See Also:

OrgContainer.restrictedDirectorySearchScope

setRestrictedDirectorySearchScope

public void setRestrictedDirectorySearchScope(boolean a_RestrictedDirectorySearchScope)
                                       throws WTPropertyVetoException

Sets the value of the attribute: restrictedDirectorySearchScope; Specifies that the directory search should be restricted, as if the OrgContainer.restrictedDirectorySearchScope were true.

Supported API: false

Parameters:

a_RestrictedDirectorySearchScope -

Throws:

WTPropertyVetoException

See Also:

OrgContainer.restrictedDirectorySearchScope

getSearchCriteria

public String getSearchCriteria()

Gets the value of the attribute: searchCriteria; A set of search conditions to filter the query by, such as: String criteria = "(" + WTUser.NAME + "=Smith" & " + WTUser.ORGANIZATION + "=PTC)";

Supported API: false

Returns:

String

setSearchCriteria

public void setSearchCriteria(String a_SearchCriteria)
                       throws WTPropertyVetoException

Sets the value of the attribute: searchCriteria; A set of search conditions to filter the query by, such as: String criteria = "(" + WTUser.NAME + "=Smith" & " + WTUser.ORGANIZATION + "=PTC)";

Supported API: false

Parameters:

a_SearchCriteria -

Throws:

WTPropertyVetoException

searchCriteriaValidate

private void searchCriteriaValidate(String a_SearchCriteria)
                             throws WTPropertyVetoException

Parameters:

a_SearchCriteria -

Throws:

WTPropertyVetoException

getSizeLimit

public int getSizeLimit()

Gets the value of the attribute: sizeLimit; The maximum number of results to return. A value of zero means that all results are returned.

Supported API: false

Returns:

int

setSizeLimit

public void setSizeLimit(int a_SizeLimit)
                  throws WTPropertyVetoException

Sets the value of the attribute: sizeLimit; The maximum number of results to return. A value of zero means that all results are returned.

Supported API: false

Parameters:

a_SizeLimit -

Throws:

WTPropertyVetoException

clone

public Object clone()

Supported API: false

Returns:

Object

getContainer

public WTContainer getContainer()

Supported API: false

Returns:

WTContainer

toString

public String toString()