LDAP Classes
Implements Java LDAP
A B C D E F G H I L M N O P R S T U

G

getAfterCount() - Method in class org.ietf.ldap.controls.LDAPVirtualListControl
Returns the number of entries after the top/center one to return per page of results.
getAttribute() - Method in class org.ietf.ldap.LDAPModification
Returns the attribute to modify, with any existing values.
getAttribute(String) - Method in class org.ietf.ldap.LDAPEntry
Returns the attributes matching the specified attrName.
getAttribute(String) - Method in class org.ietf.ldap.LDAPAttributeSet
Returns the attribute matching the specified attrName.
getAttribute(String, String) - Method in class org.ietf.ldap.LDAPAttributeSet
Returns a single best-match attribute, or null if no match is available in the entry.
getAttributeArray() - Method in class org.ietf.ldap.LDAPUrl
Returns an array of attribute names specified in the URL.
getAttributeNames() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of attribute names.
getAttributes() - Method in class org.ietf.ldap.LDAPUrl
Returns an enumerator for the attribute names specified in the URL.
getAttributes() - Method in class org.ietf.ldap.LDAPMatchingRuleUseSchema
Returns an array of all the attributes which this matching rule applies to.
getAttributes() - Method in class org.ietf.ldap.LDAPMatchingRuleSchema
Returns the OIDs of the attributes to which this rule applies.
getAttributeSchema(String) - Method in class org.ietf.ldap.LDAPSchema
Returns a particular attribute definition, or null if not found.
getAttributeSchemas() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of attribute definitions.
getAttributeSet() - Method in class org.ietf.ldap.LDAPEntry
Returns the attribute set of the entry.
getAttributeSet(String) - Method in class org.ietf.ldap.LDAPEntry
Returns an attribute set from the entry, consisting of only those attributes matching the specified subtypes.
getAuthenticationDN() - Method in class org.ietf.ldap.LDAPConnection
Returns the distinguished name (DN) used for authentication by this object.
getAuthenticationMethod() - Method in class org.ietf.ldap.LDAPConnection
Returns the method used to authenticate the connection.
getAuthProvider(String, int) - Method in interface org.ietf.ldap.LDAPAuthHandler
Returns an object which can provide authentication credentials to a server at the specified host and port.
getAuxiliaryClasses() - Method in class org.ietf.ldap.LDAPDITContentRuleSchema
Returns the list of allowed auxiliary classes.
getBaseName() - Method in class org.ietf.ldap.LDAPAttribute
Returns the base name of the attribute.
getBaseName(String) - Static method in class org.ietf.ldap.LDAPAttribute
Returns the base name of the specified attribute.
getBatchSize() - Method in class org.ietf.ldap.LDAPSearchConstraints
Returns how results are returned during a search.
getBeforeCount() - Method in class org.ietf.ldap.controls.LDAPVirtualListControl
Returns the number of entries before the top/center one to return per page of results.
getByteValueArray() - Method in class org.ietf.ldap.LDAPAttribute
Returns the values of the attribute as an array of bytes.
getByteValues() - Method in class org.ietf.ldap.LDAPAttribute
Returns an enumerator for the values of the attribute in byte format.
getCause() - Method in class org.ietf.ldap.LDAPException
Returns the lower level Exception which caused the failure, if any.
getChangeNumber() - Method in class org.ietf.ldap.controls.LDAPEntryChangeControl
returns the record number of the change in the servers change log.
getChangesOnly() - Method in class org.ietf.ldap.controls.LDAPPersistSearchControl
getChangesOnly returns true if only changes are to be returned.
getChangeType() - Method in class org.ietf.ldap.controls.LDAPEntryChangeControl
Returns the type of change that occured
getChangeTypes() - Method in class org.ietf.ldap.controls.LDAPPersistSearchControl
Returns the change types to be monitored as a logical OR of any or all of these values: ADD, DELETE, MODIFY, and/or MODDN.
getConstraints() - Method in class org.ietf.ldap.LDAPConnection
Returns a copy of the set of constraints associated with this connection.
getContentCount() - Method in class org.ietf.ldap.controls.LDAPVirtualListResponse
Returns the size of the virtual search results list.
getContext() - Method in class org.ietf.ldap.controls.LDAPVirtualListResponse
Returns the cookie used by some servers to optimize the processing of virtual list requests.
getContext() - Method in class org.ietf.ldap.controls.LDAPVirtualListControl
Returns the cookie used by some servers to optimize the processing of virtual list requests.
getControls() - Method in class org.ietf.ldap.LDAPResponse
Returns any controls in the message.
getControls() - Method in class org.ietf.ldap.LDAPMessage
Returns any controls in the message.
getControls() - Method in class org.ietf.ldap.LDAPConstraints
Returns the controls to be sent to the server.
getCount() - Method in class org.ietf.ldap.LDAPSearchResults
Returns a count of the entries in the search result.
getDereference() - Method in class org.ietf.ldap.LDAPSearchConstraints
Specifies when aliases should be dereferenced.
getDescription() - Method in class org.ietf.ldap.LDAPSchemaElement
Returns the description of the element.
getDITContentRuleNames() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of DIT content rule names.
getDITContentRuleSchema(String) - Method in class org.ietf.ldap.LDAPSchema
Returns a particular DIT content rule definition, or null if not found.
getDITContentRuleSchemas() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of DIT content rule definitions.
getDITStructureRuleNames() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of DIT structure rule names.
getDITStructureRuleSchema(int) - Method in class org.ietf.ldap.LDAPSchema
Returns a particular DIT structure rule definition, or null if not found.
getDITStructureRuleSchema(String) - Method in class org.ietf.ldap.LDAPSchema
Returns a particular DIT structure rule definition, or null if not found.
getDITStructureRuleSchemas() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of DIT structure rule definitions.
getDN() - Method in class org.ietf.ldap.LDAPUrl
Returns the distinguished name encapsulated in the URL.
getDN() - Method in class org.ietf.ldap.LDAPEntry
Returns the distinguished name of the entry.
getDN() - Method in class org.ietf.ldap.LDAPAuthProvider
Returns the distinguished name to be used for authentication on automatic referral following.
getEntry() - Method in class org.ietf.ldap.LDAPSearchResult
Returns the entry of a server's search response.
getEqualityMatchingRule() - Method in class org.ietf.ldap.LDAPAttributeSchema
Returns the matching rule for this attribute.
getErrorMessage() - Method in class org.ietf.ldap.LDAPResponse
Returns any error message in the response.
getExtensions() - Method in class org.ietf.ldap.LDAPUrl
Returns any LDAP URL extensions specified, or null if none are specified.
getFailedAttribute() - Method in class org.ietf.ldap.controls.LDAPSortResponse
If not null, this returns the attribute that caused the sort operation to fail.
getFailedReferral() - Method in class org.ietf.ldap.LDAPReferralException
Gets the referral that could not be processed.
getFilter() - Method in class org.ietf.ldap.LDAPUrl
Returns the search filter or the default filter (objectclass=*) if none was specified.
getFirstPosition() - Method in class org.ietf.ldap.controls.LDAPVirtualListResponse
Returns the index of the first entry in the returned list.
getHasChangeNumber() - Method in class org.ietf.ldap.controls.LDAPEntryChangeControl
returns the record number of the change in the servers change log.
getHopLimit() - Method in class org.ietf.ldap.LDAPConstraints
Returns the maximum number of hops to follow during automatic referral following.
getHost() - Method in class org.ietf.ldap.LDAPUrl
Returns the name of the LDAP server in the URL.
getHost() - Method in class org.ietf.ldap.LDAPConnection
Returns the host name of the LDAP server to which the object is or was last connected, in the format originally specified.
getID() - Method in class org.ietf.ldap.LDAPSchemaElement
Returns the unique object identifier (OID) of the element.
getID() - Method in class org.ietf.ldap.LDAPExtendedResponse
Returns the message identifier of the response.
getID() - Method in class org.ietf.ldap.LDAPExtendedOperation
Returns the unique identifier of the operation.
getKey() - Method in class org.ietf.ldap.controls.LDAPSortKey
Returns the attribute to used for sorting.
getLangSubtype() - Method in class org.ietf.ldap.LDAPAttribute
Returns the language subtype of the attribute, if any.
getLDAPErrorMessage() - Method in class org.ietf.ldap.LDAPException
Returns the error message from the LDAP server, if this message is available (that is, if this message was set).
getListSize() - Method in class org.ietf.ldap.controls.LDAPVirtualListControl
Returns the size of the virtual search results list.
getLocale() - Method in class org.ietf.ldap.LDAPCompareAttrNames
Returns the locale to be used for sorting, if a locale has been specified.
getLocalizedMessage() - Method in class org.ietf.ldap.LDAPException
 
getMatchedDN() - Method in class org.ietf.ldap.LDAPResponse
Returns the partially matched DN field from the server response, if the response contains one.
getMatchedDN() - Method in class org.ietf.ldap.LDAPException
Returns the part of a submitted distinguished name which could be matched by the server.
getMatchingRuleNames() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of matching rule names.
getMatchingRuleSchema(String) - Method in class org.ietf.ldap.LDAPSchema
Returns a particular matching rule definition, or null if not found.
getMatchingRuleSchemas() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of matching rule definitions.
getMatchingRuleUseNames() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of matching rule use names.
getMatchingRuleUseSchema(String) - Method in class org.ietf.ldap.LDAPSchema
Returns a particular matching rule use definition, or null if not found.
getMatchingRuleUseSchemas() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of matching rule use definitions.
getMatchRule() - Method in class org.ietf.ldap.controls.LDAPSortKey
Returns the OID to be used as a matching rule.
getMaxResults() - Method in class org.ietf.ldap.LDAPSearchConstraints
Returns the maximum number of search results to be returned; 0 means no limit.
getMessage() - Method in class org.ietf.ldap.LDAPException
 
getMessageID() - Method in class org.ietf.ldap.LDAPResponse
Returns the message ID.
getMessageID() - Method in class org.ietf.ldap.LDAPMessage
Returns the message ID.
getMessageIDs() - Method in class org.ietf.ldap.LDAPSearchQueue
Returns the message IDs for all outstanding requests.
getMessageIDs() - Method in class org.ietf.ldap.LDAPResponseQueue
Returns the message IDs for all outstanding requests.
getMessageIDs() - Method in interface org.ietf.ldap.LDAPMessageQueue
Returns the message IDs for all outstanding requests.
getName() - Method in class org.ietf.ldap.LDAPAttribute
Returns the name of the attribute.
getNameForm() - Method in class org.ietf.ldap.LDAPDITStructureRuleSchema
Returns the NameForm that this structure rule controls.
getNameFormNames() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of name form names.
getNameFormSchema(String) - Method in class org.ietf.ldap.LDAPSchema
Returns a particular name form definition, or null if not found.
getNameFormSchemas() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of name form definitions.
getNames() - Method in class org.ietf.ldap.LDAPSchemaElement
Returns an array of names for the element, or null if none is found.
getObjectClass() - Method in class org.ietf.ldap.LDAPNameFormSchema
Returns the name of the object class which this name form applies to.
getObjectClassNames() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of object class names.
getObjectClassSchema(String) - Method in class org.ietf.ldap.LDAPSchema
Returns a particular object class definition, or null if not found.
getObjectClassSchemas() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of object class definitions.
getOp() - Method in class org.ietf.ldap.LDAPModification
Returns the type of modification specified by this object.
getOptionalAttributes() - Method in class org.ietf.ldap.LDAPObjectClassSchema
Returns a list of optional attributes but not required of an entry with this object class.
getOptionalAttributes() - Method in class org.ietf.ldap.LDAPDITContentRuleSchema
Returns the list of additional optional attributes for an entry controlled by this content rule.
getOptionalNamingAttributes() - Method in class org.ietf.ldap.LDAPNameFormSchema
Returns the list of optional naming attributes for an entry controlled by this content rule.
getOrderingMatchingRule() - Method in class org.ietf.ldap.LDAPAttributeSchema
Returns the ordering matching rule for this attribute.
getPassword() - Method in class org.ietf.ldap.LDAPAuthProvider
Returns the password to be used for authentication on automatic referral following.
getPort() - Method in class org.ietf.ldap.LDAPUrl
Returns the port number of the LDAP server in the URL.
getPort() - Method in class org.ietf.ldap.LDAPConnection
Returns the port number of the LDAP server to which the object is or was last connected.
getPrecludedAttributes() - Method in class org.ietf.ldap.LDAPDITContentRuleSchema
Returns the list of precluded attributes for an entry controlled by this content rule.
getPreviousDN() - Method in class org.ietf.ldap.controls.LDAPEntryChangeControl
Returns the previous DN of the entry, if it was renamed.
getProperty(String) - Method in class org.ietf.ldap.LDAPConstraints
Returns a properties constraints objects which has been assigned with set property.
getProperty(String) - Method in class org.ietf.ldap.LDAPConnection
Returns a property of a connection object.
getProtocolVersion() - Method in class org.ietf.ldap.LDAPConnection
Returns the protocol version uses to authenticate
getQualifier(String) - Method in class org.ietf.ldap.LDAPSchemaElement
Returns an array of all values of a specified optional or non- standard qualifier of the element.
getQualifierNames() - Method in class org.ietf.ldap.LDAPSchemaElement
Returns an enumeration of all qualifiers of the element which are vendor specific (begin with "X-").
getReferralFollowing() - Method in class org.ietf.ldap.LDAPConstraints
Returns true if referrals are to be followed automatically.
getReferrals() - Method in class org.ietf.ldap.LDAPSearchResultReference
Returns any URLs in the object.
getReferrals() - Method in class org.ietf.ldap.LDAPResponse
Returns all referrals in a server response, if the response contains any.
getReferrals() - Method in class org.ietf.ldap.LDAPReferralException
Gets the list of referrals (LDAP URLs to other servers) returned by the LDAP server.
getRequiredAttributes() - Method in class org.ietf.ldap.LDAPObjectClassSchema
Returns a list of attributes required for an entry with this object class.
getRequiredAttributes() - Method in class org.ietf.ldap.LDAPDITContentRuleSchema
Returns the list of additional required attributes for an entry controlled by this content rule.
getRequiredNamingAttributes() - Method in class org.ietf.ldap.LDAPNameFormSchema
Returns the list of required naming attributes for an entry controlled by this name form.
getResponse() - Method in class org.ietf.ldap.LDAPSearchQueue
Blocks until a response is available, or until all operations associated with the object have completed or been canceled, and returns the response.
getResponse() - Method in class org.ietf.ldap.LDAPResponseQueue
Returns the response.
getResponse() - Method in interface org.ietf.ldap.LDAPMessageQueue
Returns the response from an LDAP request.
getResponse(int) - Method in class org.ietf.ldap.LDAPSearchQueue
Blocks until a response is available for a particular message id, or until all operations associated with the object have completed or been canceled, and returns the response.
getResponse(int) - Method in class org.ietf.ldap.LDAPResponseQueue
Returns the response for a particular message id.
getResponse(int) - Method in interface org.ietf.ldap.LDAPMessageQueue
Returns the response from an LDAP request for a particular msg id.
getResponseControls() - Method in class org.ietf.ldap.LDAPSearchResults
Returns the latest server controls returned by the server in the context of this search request, or null if no server controls were returned.
getResponseControls() - Method in class org.ietf.ldap.LDAPConnection
Returns the Server Controls associated with the most recent response to a synchronous request on this connection object.
getResultCode() - Method in class org.ietf.ldap.LDAPResponse
Returns the result code in a server response.
getResultCode() - Method in class org.ietf.ldap.LDAPException
Returns the result code from the exception.
getResultCode() - Method in class org.ietf.ldap.controls.LDAPVirtualListResponse
Returns the result code for the virtual list search request.
getResultCode() - Method in class org.ietf.ldap.controls.LDAPSortResponse
Returns the result code from the sort
getReturnControls() - Method in class org.ietf.ldap.controls.LDAPPersistSearchControl
Returns true if entry change controls are to be returned with the search results.
getReverse() - Method in class org.ietf.ldap.controls.LDAPSortKey
Returns the sorting order, ascending or descending.
getRuleID() - Method in class org.ietf.ldap.LDAPDITStructureRuleSchema
Returns the rule ID for this structure rule.
getSaslBindCallbackHandler() - Method in class org.ietf.ldap.LDAPConnection
Returns the call back handler if any specified on binding with a SASL mechanism.
getSaslBindProperties() - Method in class org.ietf.ldap.LDAPConnection
Returns the properties if any specified on binding with a SASL mechanism.
getSchemaDN() - Method in class org.ietf.ldap.LDAPConnection
Retrieves the DN for the schema at the root DSE of the Directory Server.
getSchemaDN(String) - Method in class org.ietf.ldap.LDAPConnection
Retrieves the DN of the schema associated with a particular entry in the directory.
getScope() - Method in class org.ietf.ldap.LDAPUrl
Returns the depth of search.
getSearchConstraints() - Method in class org.ietf.ldap.LDAPConnection
Returns a copy of the set of search constraints associated with this connection.
getServerTimeLimit() - Method in class org.ietf.ldap.LDAPSearchConstraints
Reports the maximum number of seconds that the server is to wait when returning search results while using this constraint object.
getSocketFactory() - Method in class org.ietf.ldap.LDAPConnection
Returns the LDAPSocketFactory used to establish this server connection.
getStringValueArray() - Method in class org.ietf.ldap.LDAPAttribute
Returns the values of the attribute as an array of strings.
getStringValues() - Method in class org.ietf.ldap.LDAPAttribute
Returns an enumerator for the string values of an attribute.
getSubset(String) - Method in class org.ietf.ldap.LDAPAttributeSet
Creates a new attribute set containing only the attributes that have the specified subtypes.
getSubstringMatchingRule() - Method in class org.ietf.ldap.LDAPAttributeSchema
Returns the substring matching rule for this attribute.
getSubtypes() - Method in class org.ietf.ldap.LDAPAttribute
Extracts the subtypes from the attribute name.
getSubtypes(String) - Static method in class org.ietf.ldap.LDAPAttribute
Extracts the subtypes from the specified attribute name.
getSuperior() - Method in class org.ietf.ldap.LDAPAttributeSchema
Returns the name of the attribute type which this attribute derives from, or null if there is no superior attribute.
getSuperiors() - Method in class org.ietf.ldap.LDAPObjectClassSchema
Returns the object classes from which this one derives.
getSuperiors() - Method in class org.ietf.ldap.LDAPDITStructureRuleSchema
Returns a list of all structure rules that are superior to this structure rule.
getSyntaxSchema(String) - Method in class org.ietf.ldap.LDAPSchema
Returns a particular syntax definition, or null if not found.
getSyntaxSchemas() - Method in class org.ietf.ldap.LDAPSchema
Returns an enumeration of syntax definitions.
getSyntaxString() - Method in class org.ietf.ldap.LDAPMatchingRuleSchema
Returns the OID of the syntax that this matching rule is valid for.
getSyntaxString() - Method in class org.ietf.ldap.LDAPAttributeSchema
Returns the object identifer of the syntax of the attribute, in dotted numerical format.
getTimeLimit() - Method in class org.ietf.ldap.LDAPConstraints
Returns the maximum number of milliseconds to wait for any operation under these constraints.
getType() - Method in class org.ietf.ldap.LDAPResponse
Returns the LDAP operation type of the message.
getType() - Method in class org.ietf.ldap.LDAPObjectClassSchema
Returns the type of object class.
getType() - Method in class org.ietf.ldap.LDAPMessage
Returns the LDAP operation type of the message.
getUsage() - Method in class org.ietf.ldap.LDAPAttributeSchema
Returns the usage of the attribute.
getValue() - Method in class org.ietf.ldap.LDAPExtendedResponse
Returns the value part of the response in raw bytes.
getValue() - Method in class org.ietf.ldap.LDAPExtendedOperation
Returns a reference to the operation-specific data.

LDAP Classes
Implements Java LDAP
A B C D E F G H I L M N O P R S T U
Copyright © 2002 Novell, Inc. All Rights Reserved.
Novell, Inc.
1800 South Novell Place
Provo, Ut 84606
Phone: (801) 861-5000