Skip navigation links

oracle.oud.plugin
Interface PluginContext.TypeBuilder

Enclosing class:

PluginContext

public static interface PluginContext.TypeBuilder

This interface is a builder to create new type instances.

Method Summary

Filter	newAndFilter(java.util.Collection<Filter> subFilters) Returns a new instance of an and Filter with the provided sub-filters.
Filter	newAndFilter(Filter... subFilters) Returns a new instance of an and Filter with the provided sub-filters.
Filter	newApproxMatchFilter(java.lang.String attributeDescription, ByteString assertionValue) Returns a new instance of an approximate match Filter with the specified attribute description and assertion value.
Attribute	newAttribute(java.lang.String attributeDescription, java.lang.Object... values) Returns a new instance of Attribute that has the specified attribute description and contains the provided values.
AttributeDescription	newAttributeDescription(java.lang.String attributeDescription) Returns a new instance of AttributeDescription.
AttributeValue	newAttributeValue(AttributeType type, java.lang.String value) Returns a new instance of AttributeValue of the specified type and value.
AVA	newAttributeValueAssertion(AttributeType type, java.lang.Object value) Returns a new instance of AVA (Attribute Value Assertion) with the specified type and value.
DN	newDN(java.lang.String dn) Returns a new instance of DN.
Entry	newEntry(DN dn) Returns a new instance of Entry with the specified distinguished name and no attribute.
Filter	newEqualityMatchFilter(java.lang.String attributeDescription, ByteString assertionValue) Returns a new instance of an equality match Filter with the specified attribute description and assertion value.
Filter	newExtensibleMatchFilter(java.lang.String matchingRule, java.lang.String attributeDescription, ByteString assertionValue, boolean dnAttributes) Returns a new instance of an extensible match Filter with the specified parameters.
Filter	newFilter(java.lang.String filterAsString) Returns a new instance of Filter.
Filter	newGreaterOrEqualFilter(java.lang.String attributeDescription, ByteString assertionValue) Creates a new instance of an greater or equal Filter with the specified attribute description and assertion value.
LDAPUrl	newLDAPUrl(java.lang.String ldapUrl) Returns a new instance of LDAPUrl.
Filter	newLessOrEqualFilter(java.lang.String attributeDescription, ByteString assertionValue) Returns a new instance of an less or equal Filter with the specified attribute description and assertion value.
Message	newMessage(java.lang.String message) Returns a new instance of Message.
Modification	newModification(ModificationType modificationType, Attribute attribute) Returns a new instance of Modification with the specified modification type and attribute.
Filter	newNotFilter(Filter subFilter) Returns a new instance of a not Filter with the provided sub-filter.
Filter	newOrFilter(java.util.Collection<Filter> subFilters) Returns a new instance of an or Filter with the provided sub-filters.
Filter	newOrFilter(Filter... subFilters) Returns a new instance of an or Filter with the provided sub-filters.
Filter	newPresentFilter(java.lang.String attributeDescription) Returns a new instance of an present Filter with the specified attribute description and assertion value.
RDN	newRDN(java.lang.String rdn) Returns a new instance of RDN.
Result	newResult(ResultCode resultCode) Returns a new instance of Result with the specified result code.
SearchResultEntry	newSearchResultEntry(DN dn) Returns a new instance of SearchResultEntry with the specified distinguished name, no attribute and no control.
SearchResultReference	newSearchResultReference(java.lang.String referral) Returns a new instance of SearchResultReference with the specified referral and no control.
SortKey	newSortKey(java.lang.String attributeDescription, boolean isReverseOrder, java.lang.String orderingMatchingRule) Creates a new instance of SortKey.
Filter	newSubstringsFilter(java.lang.String attributeDescription, ByteString initialSubstring, java.util.List<ByteString> anySubstrings, ByteString finalSubstring) Returns a new instance of an substrings Filter with the specified parameters.

Method Detail

newAttributeDescription

AttributeDescription newAttributeDescription(java.lang.String attributeDescription)
                                             throws PluginException

Returns a new instance of AttributeDescription.

Parameters:

attributeDescription - the String representation of the attribute description.

Returns:

a new instance of AttributeDescription.

Throws:

PluginException - if the provided attribute description could not be parsed successfully.

newAttribute

Attribute newAttribute(java.lang.String attributeDescription,
                       java.lang.Object... values)
                       throws PluginException

Returns a new instance of Attribute that has the specified attribute description and contains the provided values.

Parameters:

attributeDescription - the String representation of the attribute description.

values - the values to be added to the new attribute.

Returns:

a new instance of Attribute.

Throws:

PluginException - if the provided attribute description could not be parsed successfully.

newAttributeValue

AttributeValue newAttributeValue(AttributeType type,
                                 java.lang.String value)

Returns a new instance of AttributeValue of the specified type and value.

Parameters:

type - the type of the new AttributeValue.

value - the attribute value of the new AttributeValue.

Returns:

a new instance of AttributeValue

newDN

DN newDN(java.lang.String dn)
         throws PluginException

Returns a new instance of DN.

Parameters:

dn - the String representation of the Dn.

Returns:

a new instance of DN.

Throws:

PluginException - if the provided Dn could not be parsed successfully.

newRDN

RDN newRDN(java.lang.String rdn)
           throws PluginException

Returns a new instance of RDN.

Parameters:

rdn - the String representation of the Rdn.

Returns:

a new instance of RDN.

Throws:

PluginException - if the provided Rdn could not be parsed successfully.

newLDAPUrl

LDAPUrl newLDAPUrl(java.lang.String ldapUrl)
                   throws PluginException

Returns a new instance of LDAPUrl.

Parameters:

ldapUrl - the String representation of the Ldap Url.

Returns:

a new instance of LDAPUrl.

Throws:

PluginException - if the provided Ldap Url could not be parsed successfully.

newEntry

Entry newEntry(DN dn)

Returns a new instance of Entry with the specified distinguished name and no attribute.

Parameters:

dn - the distinguished name of this entry.

Returns:

a new instance of Entry with no attribute.

newMessage

Message newMessage(java.lang.String message)

Returns a new instance of Message.

Parameters:

message - the String representation of the message

Returns:

a new instance of Message.

newModification

Modification newModification(ModificationType modificationType,
                             Attribute attribute)

Returns a new instance of Modification with the specified modification type and attribute.

Parameters:

modificationType - the type of the new modification.

attribute - the attribute of the new modification.

Returns:

a new instance of Modification.

newAttributeValueAssertion

AVA newAttributeValueAssertion(AttributeType type,
                               java.lang.Object value)

Returns a new instance of AVA (Attribute Value Assertion) with the specified type and value.

Parameters:

type - the type of the new AVA.

value - the attribute value of the new AVA.

Returns:

a new instance of AVA

newSortKey

SortKey newSortKey(java.lang.String attributeDescription,
                   boolean isReverseOrder,
                   java.lang.String orderingMatchingRule)

Creates a new instance of SortKey.

Parameters:

attributeDescription - the name of the attribute to be sorted using this sort key.

isReverseOrder - true if this sort key should be evaluated in reverse (descending) order.

orderingMatchingRule - the name or OID of the ordering matching rule, which should be used when comparing attributes using this sort key, or null if the default ordering matching rule associated with the attribute should be used.

Returns:

a new instance of SortKey.

newFilter

Filter newFilter(java.lang.String filterAsString)
                 throws PluginException

Returns a new instance of Filter.

Parameters:

filterAsString - the String representation of the filter.

Returns:

a new instance of Filter.

Throws:

PluginException - if the provided filter could not be parsed successfully.

newAndFilter

Filter newAndFilter(Filter... subFilters)

Returns a new instance of an and Filter with the provided sub-filters.

Parameters:

subFilters - The list of sub-filters, may be empty or null.

Returns:

a new instance of an and Filter.

newApproxMatchFilter

Filter newApproxMatchFilter(java.lang.String attributeDescription,
                            ByteString assertionValue)
                            throws PluginException

Returns a new instance of an approximate match Filter with the specified attribute description and assertion value.

Parameters:

attributeDescription - the String representation of the attribute description.

assertionValue - the assertion value.

Returns:

a new instance of an approximate match Filter

Throws:

PluginException - if the provided attribute description could not be parsed successfully.

newAndFilter

Filter newAndFilter(java.util.Collection<Filter> subFilters)
                    throws PluginException

Returns a new instance of an and Filter with the provided sub-filters.

Parameters:

subFilters - The list of sub-filters, may be empty or null.

Returns:

a new instance of an and Filter.

Throws:

PluginException - if one of the provided filters is invalid.

newGreaterOrEqualFilter

Filter newGreaterOrEqualFilter(java.lang.String attributeDescription,
                               ByteString assertionValue)
                               throws PluginException

Creates a new instance of an greater or equal Filter with the specified attribute description and assertion value.

Parameters:

attributeDescription - the String representation of the attribute description.

assertionValue - the assertion value.

Returns:

a new instance of an greater or equal Filter

Throws:

PluginException - if the provided attribute description could not be parsed successfully.

newLessOrEqualFilter

Filter newLessOrEqualFilter(java.lang.String attributeDescription,
                            ByteString assertionValue)
                            throws PluginException

Returns a new instance of an less or equal Filter with the specified attribute description and assertion value.

Parameters:

attributeDescription - the String representation of the attribute description.

assertionValue - the assertion value.

Returns:

a new instance of an less or equal Filter

Throws:

PluginException - if the provided attribute description could not be parsed successfully.

newPresentFilter

Filter newPresentFilter(java.lang.String attributeDescription)
                        throws PluginException

Returns a new instance of an present Filter with the specified attribute description and assertion value.

Parameters:

attributeDescription - the String representation of the attribute description.

Returns:

a new instance of an present Filter

Throws:

PluginException - if the provided attribute description could not be parsed successfully.

newOrFilter

Filter newOrFilter(Filter... subFilters)
                   throws PluginException

Returns a new instance of an or Filter with the provided sub-filters.

Parameters:

subFilters - The list of sub-filters, may be empty or null.

Returns:

a new instance of an or Filter.

Throws:

PluginException - if one of the provided filters is invalid.

newOrFilter

Filter newOrFilter(java.util.Collection<Filter> subFilters)
                   throws PluginException

Returns a new instance of an or Filter with the provided sub-filters.

Parameters:

subFilters - The list of sub-filters, may be empty or null.

Returns:

a new instance of an or Filter.

Throws:

PluginException - if one of the provided filters is invalid.

newNotFilter

Filter newNotFilter(Filter subFilter)
                    throws PluginException

Returns a new instance of a not Filter with the provided sub-filter.

Parameters:

subFilter - The sub-filter.

Returns:

a new instance of a not Filter.

Throws:

PluginException - if the provided filter is invalid.

newEqualityMatchFilter

Filter newEqualityMatchFilter(java.lang.String attributeDescription,
                              ByteString assertionValue)
                              throws PluginException

Returns a new instance of an equality match Filter with the specified attribute description and assertion value.

Parameters:

attributeDescription - the String representation of the attribute description.

assertionValue - the assertion value.

Returns:

a new instance of an equality match Filter

Throws:

PluginException - if the provided attribute description could not be parsed successfully.

newExtensibleMatchFilter

Filter newExtensibleMatchFilter(java.lang.String matchingRule,
                                java.lang.String attributeDescription,
                                ByteString assertionValue,
                                boolean dnAttributes)
                                throws PluginException

Returns a new instance of an extensible match Filter with the specified parameters.

Parameters:

matchingRule - the matching rule name, may be null if attributeDescription is specified.

attributeDescription - the attribute description, may be null if matchingRule is specified.

assertionValue - the assertion value.

dnAttributes - indicates whether DN matching should be performed.

Returns:

a new instance of an extensible match Filter.

Throws:

PluginException - if the provided attribute description could not be parsed successfully.

newSubstringsFilter

Filter newSubstringsFilter(java.lang.String attributeDescription,
                           ByteString initialSubstring,
                           java.util.List<ByteString> anySubstrings,
                           ByteString finalSubstring)
                           throws PluginException

Returns a new instance of an substrings Filter with the specified parameters.

Parameters:

attributeDescription - the attribute description.

initialSubstring - the initial sub-string, may be null if either finalSubstring or anySubstrings are specified.

anySubstrings - the final sub-string, may be null or empty if either finalSubstring or initialSubstring are specified.

finalSubstring - the final sub-string, may be null, may be null if either initialSubstring or anySubstrings are specified.

Returns:

a new instance of an substrings Filter

Throws:

PluginException - if the provided attribute description could not be parsed successfully.

newResult

Result newResult(ResultCode resultCode)

Returns a new instance of Result with the specified result code.

Parameters:

resultCode - the result code contained in the new Result.

Returns:

a new instance of Result.

newSearchResultEntry

SearchResultEntry newSearchResultEntry(DN dn)

Returns a new instance of SearchResultEntry with the specified distinguished name, no attribute and no control.

Parameters:

dn - the distinguished name of this search result entry.

Returns:

a new instance of SearchResultEntry with no attribute and no control.

newSearchResultReference

SearchResultReference newSearchResultReference(java.lang.String referral)

Returns a new instance of SearchResultReference with the specified referral and no control.

Parameters:

referral - the referral for this search result reference.

Returns:

a new instance of SearchResultReference with the specified referral and no control.

Skip navigation links