A B C D E F G I L M N O P R S T U W X

A

ACTION_PREFIX - Static variable in interface org.openspml.message.Constants

addAttribute(String) - Method in class org.openspml.message.SearchRequest

addAttribute(String, boolean) - Method in class org.openspml.util.XmlBuffer

Adds a boolean attribute to the buffer.

addAttribute(String, int) - Method in class org.openspml.util.XmlBuffer

Adds an integer attribute to the buffer.

addAttribute(String, Object) - Method in class org.openspml.util.XmlBuffer

Add an an attribute value using an arbitrary object, by calling its toString method.

addAttribute(String, String) - Method in class org.openspml.util.XmlBuffer

addAttribute(String, String, String) - Method in class org.openspml.util.XmlBuffer

Adds an attribute name and value to the buffer.

addAttributeDefinition(AttributeDefinition) - Method in class org.openspml.message.Schema

addCondition(String, String) - Method in class org.openspml.message.SearchRequest

Convenience method to add a common equality comparison.

addContent(String) - Method in class org.openspml.util.XmlBuffer

Adds a string of element content to the buffer.

addElement(String, String) - Method in class org.openspml.util.XmlBuffer

Adds an element with content to the buffer, being careful to escape content.

addElement(String, String, String) - Method in class org.openspml.util.XmlBuffer

addEndTag(String) - Method in class org.openspml.util.XmlBuffer

Adds an element end tag.

addEndTag(String, boolean) - Method in class org.openspml.util.XmlBuffer

Adds an element end tag, with control over indentation.

addEndTag(String, String) - Method in class org.openspml.util.XmlBuffer

addEndTag(String, String, boolean) - Method in class org.openspml.util.XmlBuffer

addException(Throwable) - Method in class org.openspml.util.ExceptionWrapper

Adds another exception to the list of wrapped exceptions.

addExtendedErrorMessage(String) - Method in class org.openspml.message.SpmlResponse

Add an extended error message as an operational attribute.

addExtendedRequestDefinition(ExtendedRequestDefinition) - Method in class org.openspml.message.Schema

addFilterTerm(FilterTerm) - Method in class org.openspml.message.SearchRequest

Convenience method to add a filter term.

addIndent(int) - Method in class org.openspml.util.XmlBuffer

Add indentation to the buffer.

addListener(SOAPMonitorListener) - Method in interface org.openspml.client.SOAPMonitor

Add something interested in knowing when the monitor closes.

addMemberAttribute(AttributeDefinitionReference) - Method in class org.openspml.message.ObjectClassDefinition

addModification(Modification) - Method in class org.openspml.message.ModifyRequest

addModification(Modification) - Method in class org.openspml.message.ModifyResponse

addModification(String, Object) - Method in class org.openspml.message.ModifyRequest

addModification(String, Object) - Method in class org.openspml.message.ModifyResponse

addNamespace(String, String) - Method in class org.openspml.util.XmlBuffer

addObjectClassDefinition(ObjectClassDefinition) - Method in class org.openspml.message.Schema

addOpenStartTag(String) - Method in class org.openspml.util.XmlBuffer

Adds an open element start tag.

addOpenStartTag(String, String) - Method in class org.openspml.util.XmlBuffer

addOperand(FilterTerm) - Method in class org.openspml.message.FilterTerm

addParameter(AttributeDefinitionReference) - Method in class org.openspml.message.ExtendedRequestDefinition

AddRequest - class org.openspml.message.AddRequest.

A class used to represent an addRequest element.

AddRequest() - Constructor for class org.openspml.message.AddRequest

Construct an object representing an SPML addRequest message.

addRequest(SpmlRequest) - Method in class org.openspml.message.BatchRequest

Add one request to the batch.

AddResponse - class org.openspml.message.AddResponse.

A class used to represent an addResponse element.

AddResponse() - Constructor for class org.openspml.message.AddResponse

Construct an object representing an addReponse

addResponse(SpmlResponse) - Method in class org.openspml.message.BatchResponse

addResult(SearchResult) - Method in class org.openspml.message.SearchResponse

addReturnValue(AttributeDefinitionReference) - Method in class org.openspml.message.ExtendedRequestDefinition

addSchema(Schema) - Method in class org.openspml.message.SchemaResponse

addStartTag(String) - Method in class org.openspml.util.XmlBuffer

Adds a closed element start tag followed by a newline.

addStartTag(String, boolean) - Method in class org.openspml.util.XmlBuffer

Adds a closed element start tag with control over the trailing newline.

addStartTag(String, String) - Method in class org.openspml.util.XmlBuffer

addStartTag(String, String, boolean) - Method in class org.openspml.util.XmlBuffer

addSubclassElements(SpmlBuffer) - Method in class org.openspml.message.SchemaRequest

addSubstring(String) - Method in class org.openspml.message.FilterTerm

addSuperiorClass(ObjectClassDefinitionReference) - Method in class org.openspml.message.ObjectClassDefinition

addTerm(FilterTerm) - Method in class org.openspml.message.Filter

addValue(Object) - Method in class org.openspml.message.FilterTerm

append(char) - Method in class org.openspml.util.XmlBuffer

append(int) - Method in class org.openspml.util.XmlBuffer

append(Integer) - Method in class org.openspml.util.XmlBuffer

append(String) - Method in class org.openspml.util.XmlBuffer

Attribute - class org.openspml.message.Attribute.

A class used to represent an attr element, found in several contexts within SPML.

Attribute() - Constructor for class org.openspml.message.Attribute

Attribute(String, Object) - Constructor for class org.openspml.message.Attribute

AttributeDefinition - class org.openspml.message.AttributeDefinition.

A class representing an attributeDefinition element.

AttributeDefinition() - Constructor for class org.openspml.message.AttributeDefinition

AttributeDefinitionReference - class org.openspml.message.AttributeDefinitionReference.

A class representing an attributeDefinitionReference element.

AttributeDefinitionReference() - Constructor for class org.openspml.message.AttributeDefinitionReference

B

BatchRequest - class org.openspml.message.BatchRequest.

A class representing a collection of SPML requests to be executed as a batch.

BatchRequest() - Constructor for class org.openspml.message.BatchRequest

Create a new batch request.

batchRequest(BatchRequest) - Method in class org.openspml.client.SpmlClient

Send a BatchRequst, return a BatchResponse.

BatchResponse - class org.openspml.message.BatchResponse.

A class representing a batchResponse message.

BatchResponse() - Constructor for class org.openspml.message.BatchResponse

BatchResponse(XmlElement) - Constructor for class org.openspml.message.BatchResponse

C

CancelRequest - class org.openspml.message.CancelRequest.

A class representing a cancelRequest message.

CancelRequest() - Constructor for class org.openspml.message.CancelRequest

CancelRequest(XmlElement) - Constructor for class org.openspml.message.CancelRequest

CancelResponse - class org.openspml.message.CancelResponse.

A class representing a cancelResponse message.

CancelResponse() - Constructor for class org.openspml.message.CancelResponse

charAt(int) - Method in class org.openspml.util.XmlBuffer

clearExceptions() - Method in class org.openspml.util.ExceptionWrapper

Removes all wrapped exceptions.

clearPool() - Static method in class org.openspml.util.XmlParser

Manually clear the pool

closed(SOAPMonitor) - Method in interface org.openspml.client.SOAPMonitorListener

Called when the monitor is no longer responding to events.

closeEmptyElement() - Method in class org.openspml.util.XmlBuffer

Close an empty open start tag.

closeStartTag() - Method in class org.openspml.util.XmlBuffer

Close an open start tag.

closeStartTag(boolean) - Method in class org.openspml.util.XmlBuffer

Close an element with control over trailing newline.

Constants - interface org.openspml.message.Constants.

Various constants not related to any particular class.

createResponse() - Method in class org.openspml.message.SpmlRequest

Build an empty SpmlRequest object that corresponds to this request.

createResponse() - Method in class org.openspml.message.BatchRequest

createResponse() - Method in class org.openspml.message.StatusRequest

createResponse() - Method in class org.openspml.message.DeleteRequest

createResponse() - Method in class org.openspml.message.ExtendedRequest

createResponse() - Method in class org.openspml.message.SearchRequest

createResponse() - Method in class org.openspml.message.AddRequest

createResponse() - Method in class org.openspml.message.CancelRequest

createResponse() - Method in class org.openspml.message.ModifyRequest

createResponse() - Method in class org.openspml.message.SchemaRequest

createResponseForRequest(Element) - Static method in class org.openspml.message.SpmlResponse

Static method to create an empty response object that corresponds to an request element.

createResponseForRequest(XmlElement) - Static method in class org.openspml.message.SpmlResponse

Static method to create an empty response object that corresponds to an request element.

createUser(String, Map) - Method in class org.openspml.client.LighthouseClient

Create a new Lighthouse user, with attributes specified in a Map.

D

decIndent() - Method in class org.openspml.util.XmlBuffer

decIndent(int) - Method in class org.openspml.util.XmlBuffer

Decrement the indentation level.

decodeCommaString(String) - Static method in class org.openspml.util.Util

decodeCommaString(String, boolean) - Static method in class org.openspml.util.Util

decodeNewlineString(String, boolean) - Static method in class org.openspml.util.Util

Given a newline deliminted string, break it up into a List of Strings.

DeleteRequest - class org.openspml.message.DeleteRequest.

A class used to represent a deleteRequest element.

DeleteRequest() - Constructor for class org.openspml.message.DeleteRequest

DeleteResponse - class org.openspml.message.DeleteResponse.

A class used to represent a deleteResponse element.

DeleteResponse() - Constructor for class org.openspml.message.DeleteResponse

deleteUser(String, List) - Method in class org.openspml.client.LighthouseClient

Delete the Lighthouse user and deprovision all associated resource accounts.

dumpFile(String) - Method in class org.openspml.message.SpmlResponse

Handy function to call in the debugger.

dumpFile(String) - Method in class org.openspml.message.SpmlRequest

Handy function to call in the debugger.

dumpPool() - Static method in class org.openspml.util.XmlParser

Dump information about the pool.

E

EL_SEARCH_BASE - Static variable in class org.openspml.message.SearchRequest

ELEMENT - Static variable in class org.openspml.message.StatusRequest

encodeCommaString(List) - Static method in class org.openspml.util.Util

Convert a list of strings into a comma delimited list.

encodeCommaString(List, boolean) - Static method in class org.openspml.util.Util

ENUM_PREFIX - Static variable in interface org.openspml.message.Constants

Prefix used for various enumeration values.

ERROR_CUSTOM_ERROR - Static variable in class org.openspml.message.SpmlResponse

Error code indicating that a PSP specific error was returned.

ERROR_MALFORMED_REQUEST - Static variable in class org.openspml.message.SpmlResponse

Error code indicating a request formatting error.

ERROR_NO_SUCH_IDENTIFIER - Static variable in class org.openspml.message.SpmlResponse

Error code indicating that the identifier provided in the request did not match an object managed by the server.

ERROR_NO_SUCH_REQUEST - Static variable in class org.openspml.message.SpmlResponse

Error code indicating that the the identifier for an extended request was not recognized.

ERROR_UNSUPPORTED_IDENTIFIER_TYPE - Static variable in class org.openspml.message.SpmlResponse

Error code indicating that an identifier type used in the request is not supported by the server.

ERROR_UNSUPPORTED_OPERATION - Static variable in class org.openspml.message.SpmlResponse

Error code indicating that the requested operation is not supported by the server.

error(SAXParseException) - Method in class org.openspml.util.XmlParser

Parser error callback handler

ExceptionWrapper - exception org.openspml.util.ExceptionWrapper.

An exception class that can wrap other exceptions.

ExceptionWrapper() - Constructor for class org.openspml.util.ExceptionWrapper

Construct an empty exception wrapper.

ExceptionWrapper(String) - Constructor for class org.openspml.util.ExceptionWrapper

Construct an exception wrapper with a detail message.

ExceptionWrapper(String, Throwable) - Constructor for class org.openspml.util.ExceptionWrapper

Create an exception wrapper from an existing exception but with a different detail message.

ExceptionWrapper(Throwable) - Constructor for class org.openspml.util.ExceptionWrapper

Construct an exception wrapper with an existing exception.

EXEC_ASYNCHRONOUS - Static variable in class org.openspml.message.SpmlRequest

EXEC_SYNCHRONOUS - Static variable in class org.openspml.message.SpmlRequest

Internal constants for the execution type.

ExtendedRequest - class org.openspml.message.ExtendedRequest.

A class used to represent an extendedRequest element.

ExtendedRequest() - Constructor for class org.openspml.message.ExtendedRequest

extendedRequest(ExtendedRequest) - Method in class org.openspml.client.SpmlClient

Summit a single ExtendedRequest.

ExtendedRequestDefinition - class org.openspml.message.ExtendedRequestDefinition.

A class representing an extendedRequestDefinition element.

ExtendedRequestDefinition() - Constructor for class org.openspml.message.ExtendedRequestDefinition

ExtendedResponse - class org.openspml.message.ExtendedResponse.

A class used to represent an extendedResponse element.

ExtendedResponse() - Constructor for class org.openspml.message.ExtendedResponse

F

fatalError(SAXParseException) - Method in class org.openspml.util.XmlParser

Parser fatal error callback handler.

Filter - class org.openspml.message.Filter.

Memory representation for the filter element found within a searchRequest message.

Filter() - Constructor for class org.openspml.message.Filter

FilterTerm - class org.openspml.message.FilterTerm.

A class used to represent one filter expression term, found within a filter element of a searchRequest message.

FilterTerm() - Constructor for class org.openspml.message.FilterTerm

FilterTerm(String) - Constructor for class org.openspml.message.FilterTerm

find(List, String) - Static method in class org.openspml.message.AttributeDefinition

findFile(String) - Static method in class org.openspml.util.Util

findFile(String, String) - Static method in class org.openspml.util.Util

findOutputFile(String) - Static method in class org.openspml.util.Util

Build an absolute path name for a file.

G

getAllMessages() - Method in class org.openspml.util.ExceptionWrapper

Return a string containing the exception class name and messages for all wrapped exceptions.

getAttribute(List, String) - Static method in class org.openspml.message.Attribute

Utility method to Lookup an attribute by name given a list of attributes.

getAttribute(String) - Method in class org.openspml.util.XmlElement

Return the value of an attribute.

getAttribute(String) - Method in class org.openspml.message.BatchRequest

Lookup a batch attribute by name.

getAttribute(String) - Method in class org.openspml.message.ExtendedResponse

Lookup an attribute by name.

getAttribute(String) - Method in class org.openspml.message.ExtendedRequest

getAttribute(String) - Method in class org.openspml.message.AddRequest

Retrieve an attribute by name.

getAttribute(String) - Method in class org.openspml.message.AddResponse

Retrieve an attribute by name.

getAttribute(String) - Method in class org.openspml.message.SearchResult

getAttributeDefinition(String) - Method in class org.openspml.message.Schema

getAttributeDefinitions() - Method in class org.openspml.message.ObjectClassDefinition

Convenience accessor to return a list of resolved AttributeDefinition objects.

getAttributeDefinitions() - Method in class org.openspml.message.Schema

getAttributeDefinitions(List) - Method in class org.openspml.message.Schema

Convenience accessor to return a list of resolved AttributeDefinition objects.

getAttributeMap() - Method in class org.openspml.message.SearchResult

getAttributes() - Method in class org.openspml.message.BatchRequest

Get the list of batch attributes.

getAttributes() - Method in class org.openspml.message.ExtendedResponse

getAttributes() - Method in class org.openspml.message.ExtendedRequest

getAttributes() - Method in class org.openspml.message.BatchResponse

getAttributes() - Method in class org.openspml.message.SearchRequest

getAttributes() - Method in class org.openspml.message.AddRequest

Retrieve the list of attributes.

getAttributes() - Method in class org.openspml.message.Identifier

getAttributes() - Method in class org.openspml.message.AddResponse

Return the list of all attributes that were assigned as as a side effect.

getAttributes() - Method in class org.openspml.message.SearchResult

getAttributes(Map) - Static method in class org.openspml.message.Attribute

Convenience method to build a List of Attribute objects given a Map of name/value pairs.

getAttributeValue(List, String) - Static method in class org.openspml.message.Attribute

Utility method to Lookup an attribute by name given a list of attributes.

getAttributeValue(String) - Method in class org.openspml.message.BatchRequest

Lookup a batch attribute by name.

getAttributeValue(String) - Method in class org.openspml.message.ExtendedResponse

getAttributeValue(String) - Method in class org.openspml.message.ExtendedRequest

getAttributeValue(String) - Method in class org.openspml.message.AddRequest

Retrieve the value of an attribute.

getAttributeValue(String) - Method in class org.openspml.message.AddResponse

Retrieve the value of an attribute.

getAttributeValue(String) - Method in class org.openspml.message.SearchResult

getBooleanAttribute(String) - Method in class org.openspml.util.XmlElement

Return a boolean attribute value.

getCancelResult() - Method in class org.openspml.message.CancelResponse

getChildElement() - Method in class org.openspml.util.XmlElement

Return the first child element.

getChildElement(String) - Method in class org.openspml.util.XmlElement

Return the first child element with the given local name.

getContent() - Method in class org.openspml.util.XmlElement

Return the content of the given element.

getDefinition() - Method in class org.openspml.message.AttributeDefinitionReference

getDefinition() - Method in class org.openspml.message.ObjectClassDefinitionReference

getDescription() - Method in class org.openspml.message.AttributeDefinition

getDescription() - Method in class org.openspml.message.ObjectClassDefinition

getDescription() - Method in class org.openspml.message.ExtendedRequestDefinition

getElementName() - Method in class org.openspml.message.ExtendedRequestDefinition

getElementName() - Method in class org.openspml.message.SpmlRequest

Return the tag name for the request element.

getElementName() - Method in class org.openspml.message.BatchRequest

getElementName() - Method in class org.openspml.message.StatusRequest

getElementName() - Method in class org.openspml.message.DeleteRequest

SpmlRequest.toXml does it all, we have nothing to add beyond our specific element name.

getElementName() - Method in class org.openspml.message.ExtendedRequest

getElementName() - Method in class org.openspml.message.SearchRequest

getElementName() - Method in class org.openspml.message.AddRequest

getElementName() - Method in class org.openspml.message.CancelRequest

getElementName() - Method in class org.openspml.message.ModifyRequest

getElementName() - Method in class org.openspml.message.SchemaRequest

SpmlRequest.toXml does it all, we have nothing to add beyond our specific element name.

getError() - Method in class org.openspml.message.SpmlResponse

getErrorMessage() - Method in class org.openspml.message.SpmlResponse

getException() - Method in class org.openspml.util.ExceptionWrapper

Returns the first embedded exception, if any.

getException(int) - Method in class org.openspml.util.ExceptionWrapper

Returns the Nth embedded exception, if any.

getExceptionCount() - Method in class org.openspml.util.ExceptionWrapper

Returns the number of wrapped Exceptions.

getExceptions() - Method in class org.openspml.util.ExceptionWrapper

Return the list of nested exceptions.

getExtendedErrorMessages() - Method in class org.openspml.message.SpmlResponse

getExtendedRequestDefinitions() - Method in class org.openspml.message.Schema

getFilePath(String) - Static method in class org.openspml.util.XmlParser

Build an absolute path name for a file.

getFilter() - Method in class org.openspml.message.SearchRequest

getFinalSubstring() - Method in class org.openspml.message.FilterTerm

getId() - Method in class org.openspml.message.SchemaIdentifier

getId() - Method in class org.openspml.message.OperationIdentifier

getId() - Method in class org.openspml.message.Identifier

getId() - Method in class org.openspml.message.ProviderIdentifier

getIdentifier() - Method in class org.openspml.message.SpmlRequest

Return the target object identifier.

getIdentifier() - Method in class org.openspml.message.AddResponse

Return the identifier of the object that was added.

getIdentifier() - Method in class org.openspml.message.SearchResult

getIdentifierString() - Method in class org.openspml.message.SpmlRequest

Return the target object identifier as a string.

getIdentifierString() - Method in class org.openspml.message.AddResponse

Return the identifier of the object that was added as a string.

getIdentifierString() - Method in class org.openspml.message.SearchResult

getInitialSubstring() - Method in class org.openspml.message.FilterTerm

getLocalName() - Method in class org.openspml.util.XmlElement

Return the element tag name without the namespace qualifier.

getMajorVersion() - Method in class org.openspml.message.Schema

getMatchRule() - Method in class org.openspml.message.FilterTerm

getMemberAttributes() - Method in class org.openspml.message.ObjectClassDefinition

getMessage() - Method in class org.openspml.util.ExceptionWrapper

Return a detail message for this exception.

getMinorVersion() - Method in class org.openspml.message.Schema

getModifications() - Method in class org.openspml.message.ModifyRequest

getModifications() - Method in class org.openspml.message.ModifyResponse

getName() - Method in class org.openspml.message.FilterTerm

getName() - Method in class org.openspml.message.AttributeDefinition

getName() - Method in class org.openspml.message.Attribute

getName() - Method in class org.openspml.message.ObjectClassDefinition

getName() - Method in class org.openspml.message.AttributeDefinitionReference

getName() - Method in class org.openspml.message.ObjectClassDefinitionReference

getNamespaceURI() - Method in class org.openspml.util.XmlElement

Given an element with a namespace prefix and a namespace declaration for that prefix, return the namespace URI.

getNextElement() - Method in class org.openspml.util.XmlElement

Get the next right sibling that is an element.

getObjectClass() - Method in class org.openspml.message.AddRequest

Retrieve the value of the "objectclass" attribute.

getObjectClassDefinition(String) - Method in class org.openspml.message.Schema

getObjectClassDefinitions() - Method in class org.openspml.message.Schema

getOperands() - Method in class org.openspml.message.FilterTerm

getOperation() - Method in class org.openspml.message.FilterTerm

getOperation() - Method in class org.openspml.message.Modification

getOperationalAttribute(String) - Method in class org.openspml.message.SpmlResponse

getOperationalAttribute(String) - Method in class org.openspml.message.SpmlRequest

Lookup an attribute by name.

getOperationalAttributes() - Method in class org.openspml.message.SpmlResponse

getOperationalAttributes() - Method in class org.openspml.message.SpmlRequest

Return the list of operational attributes.

getOperationalAttributeValue(String) - Method in class org.openspml.message.SpmlResponse

getOperationalAttributeValue(String) - Method in class org.openspml.message.SpmlRequest

getOperationIdentifier() - Method in class org.openspml.message.ExtendedRequestDefinition

getOperationIdentifier() - Method in class org.openspml.message.ExtendedRequest

getOperationIdentifierString() - Method in class org.openspml.message.ExtendedRequestDefinition

getParameterDefinitions() - Method in class org.openspml.message.ExtendedRequestDefinition

Convenience accessor to return a list of resolved AttributeDefinition objects.

getParameters() - Method in class org.openspml.message.ExtendedRequestDefinition

getParser() - Static method in class org.openspml.util.XmlParser

Obtain a parser from the pool.

getParser(boolean) - Static method in class org.openspml.util.XmlParser

getPrefix() - Method in class org.openspml.util.XmlElement

Return the namespace prefix.

getProperties() - Method in class org.openspml.message.AttributeDefinition

getProperties() - Method in class org.openspml.message.ObjectClassDefinition

getProperties() - Method in class org.openspml.message.ExtendedRequestDefinition

getProperty(String) - Method in class org.openspml.message.AttributeDefinition

getProperty(String) - Method in class org.openspml.message.ObjectClassDefinition

getProperty(String) - Method in class org.openspml.message.ExtendedRequestDefinition

getProviderIdentifier() - Method in class org.openspml.message.AttributeDefinitionReference

getProviderIdentifier() - Method in class org.openspml.message.ExtendedRequest

getProviderIdentifier() - Method in class org.openspml.message.ObjectClassDefinitionReference

getProviderIdentifier() - Method in class org.openspml.message.Schema

getProviderIdentifier() - Method in class org.openspml.message.SchemaRequest

getProviderIdentifierString() - Method in class org.openspml.message.AttributeDefinitionReference

getProviderIdentifierString() - Method in class org.openspml.message.ObjectClassDefinitionReference

getProviderIdentifierString() - Method in class org.openspml.message.Schema

getRequestId() - Method in class org.openspml.message.SpmlResponse

getRequestId() - Method in class org.openspml.message.SpmlRequest

Return the optional request id.

getRequests() - Method in class org.openspml.message.BatchRequest

Get the list of requests in the batch.

getResponse() - Method in class org.openspml.message.StatusResponse

getResponse(Class) - Method in class org.openspml.message.BatchResponse

Return a response of a given class.

getResponses() - Method in class org.openspml.message.BatchResponse

getResult() - Method in class org.openspml.message.SpmlResponse

getResults() - Method in class org.openspml.message.SearchResponse

getReturnValues() - Method in class org.openspml.message.ExtendedRequestDefinition

getSchema() - Method in class org.openspml.message.SchemaResponse

Get the "primary" schema, presumably the first one on the list, and generally there will be only one.

getSchemaIdentifier() - Method in class org.openspml.message.AttributeDefinitionReference

getSchemaIdentifier() - Method in class org.openspml.message.ObjectClassDefinitionReference

getSchemaIdentifier() - Method in class org.openspml.message.Schema

getSchemaIdentifier() - Method in class org.openspml.message.SchemaRequest

getSchemaIdentifierString() - Method in class org.openspml.message.AttributeDefinitionReference

getSchemaIdentifierString() - Method in class org.openspml.message.ObjectClassDefinitionReference

getSchemaIdentifierString() - Method in class org.openspml.message.Schema

getSchemas() - Method in class org.openspml.message.SchemaResponse

getSearchBase() - Method in class org.openspml.message.SearchRequest

getStatus(StringBuffer) - Static method in class org.openspml.util.XmlParser

Retrieve information about the pool.

getSubstrings() - Method in class org.openspml.message.FilterTerm

getSuperiorClasses() - Method in class org.openspml.message.ObjectClassDefinition

getTagName() - Method in class org.openspml.util.XmlElement

getTerms() - Method in class org.openspml.message.Filter

getType() - Method in class org.openspml.message.AttributeDefinition

getType() - Method in class org.openspml.message.SchemaIdentifier

getType() - Method in class org.openspml.message.OperationIdentifier

getType() - Method in class org.openspml.message.Identifier

getType() - Method in class org.openspml.message.ProviderIdentifier

getUser(String) - Method in class org.openspml.client.LighthouseClient

Return the attriutes of a Lighthouse user as a Map.

getValue() - Method in class org.openspml.message.FilterTerm

getValue() - Method in class org.openspml.message.Attribute

getValues() - Method in class org.openspml.message.FilterTerm

I

Identifier - class org.openspml.message.Identifier.

A class used to represent an identifier element, found in several contexts within SPML messages.

Identifier() - Constructor for class org.openspml.message.Identifier

Arbitrary DOM for complex identifiers.

Identifier(String) - Constructor for class org.openspml.message.Identifier

incIndent() - Method in class org.openspml.util.XmlBuffer

incIndent(int) - Method in class org.openspml.util.XmlBuffer

Increment the indentation level.

isAbsolutePath(String) - Static method in class org.openspml.util.Util

isAsynchronous() - Method in class org.openspml.message.SpmlRequest

Return true if asynchronous execution was requested.

isDnAttributes() - Method in class org.openspml.message.FilterTerm

isFailure() - Method in class org.openspml.message.SpmlResponse

isMulti() - Method in class org.openspml.message.AttributeDefinition

isOnErrorResume() - Method in class org.openspml.message.BatchRequest

Returns true if the batch is to continue even if individual requests have errors.

isOperation(String) - Method in class org.openspml.message.FilterTerm

isParallel() - Method in class org.openspml.message.BatchRequest

Returns true if parallel execution is desired.

isRequired() - Method in class org.openspml.message.AttributeDefinitionReference

isReturnResult() - Method in class org.openspml.message.StatusRequest

itoa(int) - Static method in class org.openspml.util.XmlParser

L

length() - Method in class org.openspml.util.XmlBuffer

LighthouseClient - class org.openspml.client.LighthouseClient.

A class that wraps a SpmlClient instance to provide a more Lighthouse-specific interface.

LighthouseClient() - Constructor for class org.openspml.client.LighthouseClient

Construct a new lighthouse client.

login() - Method in class org.openspml.client.LighthouseClient

Login to the Lighthouse server.

logout() - Method in class org.openspml.client.LighthouseClient

Logout of the Lighthouse server.

M

main(String[]) - Static method in class org.openspml.util.XmlParser

Parses an XML file, and displays any error or warning messages.

Modification - class org.openspml.message.Modification.

Memory representation for a modification element, found within a modifyRequest message.

Modification() - Constructor for class org.openspml.message.Modification

Modification(String, Object) - Constructor for class org.openspml.message.Modification

ModifyRequest - class org.openspml.message.ModifyRequest.

A class used to represent a modifyRequest element.

ModifyRequest() - Constructor for class org.openspml.message.ModifyRequest

ModifyResponse - class org.openspml.message.ModifyResponse.

A class used to represent a modifyResponse element.

ModifyResponse() - Constructor for class org.openspml.message.ModifyResponse

N

next() - Method in class org.openspml.util.XmlElement

Assimilate the next right sibling within this element wrapper.

O

ObjectClassDefinition - class org.openspml.message.ObjectClassDefinition.

A class representing an objectClassDefinition element.

ObjectClassDefinition() - Constructor for class org.openspml.message.ObjectClassDefinition

ObjectClassDefinitionReference - class org.openspml.message.ObjectClassDefinitionReference.

A class representing an attributeDefinitionReference element.

ObjectClassDefinitionReference() - Constructor for class org.openspml.message.ObjectClassDefinitionReference

ON_ERROR_EXIT - Static variable in class org.openspml.message.BatchRequest

ON_ERROR_RESUME - Static variable in class org.openspml.message.BatchRequest

OP_ADD - Static variable in class org.openspml.message.Modification

Constant used with setOperation to indicate that the modification list is to be merged with the current value of the attribute.

OP_AND - Static variable in class org.openspml.message.FilterTerm

Constant used with setOperation to specify the "and" operator.

OP_APPROX - Static variable in class org.openspml.message.FilterTerm

Constant used with setOperator to specify an "approxomate match" comparison.

OP_DELETE - Static variable in class org.openspml.message.Modification

Constant used with setOperation to indicate that the values on the modification list are to be removed from the current value of the attribute.

OP_EQUAL - Static variable in class org.openspml.message.FilterTerm

Constant used with setOperator to specify an equality comparison.

OP_EXTENSIBLE_MATCH - Static variable in class org.openspml.message.FilterTerm

Constant used with setOperator to specify an "extensible match" comparison.

OP_GTE - Static variable in class org.openspml.message.FilterTerm

Constant used with setOperator to specify a greater than or equal comparison.

OP_LTE - Static variable in class org.openspml.message.FilterTerm

Constant used with setOperator to specify a less than or equal comparison.

OP_NOT - Static variable in class org.openspml.message.FilterTerm

Constant used with setOperator to specify the "not" operator.

OP_OR - Static variable in class org.openspml.message.FilterTerm

Constant used with setOperation to specify the "or" operator.

OP_PRESENT - Static variable in class org.openspml.message.FilterTerm

Constant used with setOperator to specify a "present" comparison.

OP_REPLACE - Static variable in class org.openspml.message.Modification

Constant used with setOperation to indicate that the modification list is to replace the entire value of the attribute.

OP_SUBSTRINGS - Static variable in class org.openspml.message.FilterTerm

Constant used with setOperator to specify an substring comparison.

OperationIdentifier - class org.openspml.message.OperationIdentifier.

A class used to represent an operationIdentifier element found within an extendedRequest

OperationIdentifier() - Constructor for class org.openspml.message.OperationIdentifier

OperationIdentifier(String) - Constructor for class org.openspml.message.OperationIdentifier

org.openspml.client - package org.openspml.client

org.openspml.message - package org.openspml.message

org.openspml.util - package org.openspml.util

P

parse(String, boolean) - Static method in class org.openspml.util.XmlParser

Parses a string with or without validation and returns the Document.

parseRequest(Element) - Static method in class org.openspml.message.SpmlRequest

Parse one of the "root" requests.

parseRequest(XmlElement) - Static method in class org.openspml.message.SpmlRequest

Parse one of the "root" requests.

parseResponse(Element) - Static method in class org.openspml.message.SpmlResponse

Static method to parse any root SPML response.

parseResponse(String) - Static method in class org.openspml.message.SpmlResponse

Static method to parse the XML for one of the SpmlResponse classes and return the correct object.

parseResponse(XmlElement) - Static method in class org.openspml.message.SpmlResponse

Static method to parse any root SPML response.

parseString(String) - Method in class org.openspml.util.XmlParser

Parses a string and returns the Document.

pool() - Method in class org.openspml.util.XmlParser

Return the parser to the pool.

poolParser(XmlParser) - Static method in class org.openspml.util.XmlParser

Return an object to the pool.

println(String) - Static method in class org.openspml.client.SpmlClient

printStackTrace() - Method in class org.openspml.util.ExceptionWrapper

Throwable overload to cause printing of the nested exception stack traces as well as our own.

printStackTrace(PrintStream) - Method in class org.openspml.util.ExceptionWrapper

Throwable overload to cause printing of the nested exception stack traces as well as our own.

printStackTrace(PrintWriter) - Method in class org.openspml.util.ExceptionWrapper

Throwable overload to cause printing of the nested exception stack traces as well as our own.

PROC_PARALLEL - Static variable in class org.openspml.message.BatchRequest

PROC_SEQUENTIAL - Static variable in class org.openspml.message.BatchRequest

ProviderIdentifier - class org.openspml.message.ProviderIdentifier.

A class used to represent a providerIdentifier element used with extendedRequest and schemaRequest messages.

ProviderIdentifier() - Constructor for class org.openspml.message.ProviderIdentifier

ProviderIdentifier(String) - Constructor for class org.openspml.message.ProviderIdentifier

ProviderIdentifier(XmlElement) - Constructor for class org.openspml.message.ProviderIdentifier

R

readFile(String) - Static method in class org.openspml.util.XmlParser

Read the contents of a file and return it as a String.

readFile(String) - Static method in class org.openspml.util.Util

Read the contents of a file and return it as a String.

readFileBytes(File) - Static method in class org.openspml.util.XmlParser

readFileBytes(File) - Static method in class org.openspml.util.Util

Read the contents of a file and return it as a String.

readFileBytes(String) - Static method in class org.openspml.util.XmlParser

readInputStreamBytes(InputStream, boolean) - Static method in class org.openspml.util.XmlParser

receive() - Method in class org.openspml.client.SOAPClient

Retrieve a response to a previous send call and return it as a string of XML.

receive(String) - Method in interface org.openspml.client.SOAPMonitor

Called immediately after a SOAP message is received.

removeAttributes(List) - Method in class org.openspml.message.SearchResponse

Remove response attributes with certain names.

removeAttributes(List) - Method in class org.openspml.message.SearchResult

Remove response attributes with certain names.

removeListener(SOAPMonitorListener) - Method in interface org.openspml.client.SOAPMonitor

Remove a previously isntalled listener.

removeOperationalAttribute(String) - Method in class org.openspml.message.SpmlResponse

request(SpmlRequest) - Method in class org.openspml.client.SpmlClient

Send any request, return the corresponding response.

request(SpmlRequest) - Method in class org.openspml.client.LighthouseClient

Overload this to ensure a login before proceeding.

resolveEntity(String, String) - Method in class org.openspml.util.XmlParser

Attempt to resolve an entity reference to an absolute file path.

RESULT_CANCELED - Static variable in class org.openspml.message.CancelResponse

RESULT_COULD_NOT_CANCEL - Static variable in class org.openspml.message.CancelResponse

RESULT_FAILURE - Static variable in class org.openspml.message.SpmlResponse

Result code representing failure.

RESULT_NO_SUCH_REQUEST - Static variable in class org.openspml.message.CancelResponse

RESULT_PENDING - Static variable in class org.openspml.message.SpmlResponse

Result code indicating that the request is still pending.

RESULT_SUCCESS - Static variable in class org.openspml.message.SpmlResponse

Result codes representing success.

RETURN_RESULT - Static variable in class org.openspml.message.StatusRequest

RETURN_STATUS - Static variable in class org.openspml.message.StatusRequest

S

saxParse(InputStream, ContentHandler) - Method in class org.openspml.util.XmlParser

Parse a stream using SAX.

saxParse(String, ContentHandler) - Method in class org.openspml.util.XmlParser

Parse a uri using SAX.

saxParseString(String, ContentHandler) - Method in class org.openspml.util.XmlParser

Parse a string using SAX.

Schema - class org.openspml.message.Schema.

A class representing a schema element.

Schema() - Constructor for class org.openspml.message.Schema

Schema(String) - Constructor for class org.openspml.message.Schema

Build a Schema object from an XML string.

SchemaIdentifier - class org.openspml.message.SchemaIdentifier.

A class used to represent a schemaIdentifier element.

SchemaIdentifier() - Constructor for class org.openspml.message.SchemaIdentifier

SchemaIdentifier(String) - Constructor for class org.openspml.message.SchemaIdentifier

SchemaIdentifier(XmlElement) - Constructor for class org.openspml.message.SchemaIdentifier

SchemaRequest - class org.openspml.message.SchemaRequest.

A class representing a schemaRequest element.

SchemaRequest() - Constructor for class org.openspml.message.SchemaRequest

SchemaRequest(XmlElement) - Constructor for class org.openspml.message.SchemaRequest

SchemaResponse - class org.openspml.message.SchemaResponse.

A class representing a schemaResponse element.

SchemaResponse() - Constructor for class org.openspml.message.SchemaResponse

SearchRequest - class org.openspml.message.SearchRequest.

A class used to represent a searchRequest element.

SearchRequest() - Constructor for class org.openspml.message.SearchRequest

searchRequest(SearchRequest) - Method in class org.openspml.client.SpmlClient

Submit a single SearchRequest.

SearchResponse - class org.openspml.message.SearchResponse.

A class used to represent a searchResponse element.

SearchResponse() - Constructor for class org.openspml.message.SearchResponse

SearchResult - class org.openspml.message.SearchResult.

A class used to represent a searchResult message.

SearchResult() - Constructor for class org.openspml.message.SearchResult

send(String) - Method in interface org.openspml.client.SOAPMonitor

Called immediately before a SOAP message is sent.

send(URL, String, String) - Method in class org.openspml.client.SOAPClient

Send a SOAP message already rendered as XML wrapping it in a suitable Envelope and Body.

setAction(String) - Method in class org.openspml.client.SpmlClient

Set the "SOAP action name" which may be requried by the SOAP router in the application server.

setAsynchronous(boolean) - Method in class org.openspml.message.SpmlRequest

Set a flag indicating whether the request is to be performed asynchronously.

setAttribute(Attribute) - Method in class org.openspml.message.BatchRequest

Set one batch attribute.

setAttribute(Attribute) - Method in class org.openspml.message.ExtendedResponse

setAttribute(Attribute) - Method in class org.openspml.message.ExtendedRequest

setAttribute(Attribute) - Method in class org.openspml.message.BatchResponse

setAttribute(Attribute) - Method in class org.openspml.message.AddRequest

Sets one attribute.

setAttribute(Attribute) - Method in class org.openspml.message.Identifier

setAttribute(Attribute) - Method in class org.openspml.message.AddResponse

Set one attribute to be included in the response.

setAttribute(Attribute) - Method in class org.openspml.message.SearchResult

setAttribute(String, Object) - Method in class org.openspml.message.BatchRequest

Set one batch attribute.

setAttribute(String, Object) - Method in class org.openspml.message.ExtendedResponse

setAttribute(String, Object) - Method in class org.openspml.message.ExtendedRequest

setAttribute(String, Object) - Method in class org.openspml.message.BatchResponse

setAttribute(String, Object) - Method in class org.openspml.message.AddRequest

Sets one attribute as a name/value pair.

setAttribute(String, Object) - Method in class org.openspml.message.AddResponse

Set one attribute to be included in the response.

setAttribute(String, Object) - Method in class org.openspml.message.SearchResult

setAttributeDefinitions(List) - Method in class org.openspml.message.Schema

setAttributes(List) - Method in class org.openspml.message.BatchRequest

Set a collection of attribute that applies to the batch .

setAttributes(List) - Method in class org.openspml.message.ExtendedResponse

setAttributes(List) - Method in class org.openspml.message.ExtendedRequest

setAttributes(List) - Method in class org.openspml.message.BatchResponse

setAttributes(List) - Method in class org.openspml.message.SearchRequest

setAttributes(List) - Method in class org.openspml.message.AddRequest

Sets the list of attributes.

setAttributes(List) - Method in class org.openspml.message.Identifier

setAttributes(List) - Method in class org.openspml.message.AddResponse

Sets the list of object attributes to include in the response.

setAttributes(List) - Method in class org.openspml.message.SearchResult

setAttributes(Map) - Method in class org.openspml.message.ExtendedResponse

setAttributes(Map) - Method in class org.openspml.message.AddRequest

Sets the attributes from a map of name/value pairs.

setAttributes(Map) - Method in class org.openspml.message.AddResponse

Sets the list of attributes from a map of name/value pairs.

setBodyAttributes(String) - Method in class org.openspml.client.SpmlClient

Set an optional list of attributes for the SOAP Body.

setBodyAttributes(String) - Method in class org.openspml.client.SOAPClient

setCancelResult(String) - Method in class org.openspml.message.CancelResponse

setDescription(String) - Method in class org.openspml.message.AttributeDefinition

setDescription(String) - Method in class org.openspml.message.ObjectClassDefinition

setDescription(String) - Method in class org.openspml.message.ExtendedRequestDefinition

setDnAttributes(boolean) - Method in class org.openspml.message.FilterTerm

setError(String) - Method in class org.openspml.message.SpmlResponse

setErrorMessage(String) - Method in class org.openspml.message.SpmlResponse

setErrorMessage(Throwable) - Method in class org.openspml.message.SpmlResponse

setExtendedRequestDefinitions(List) - Method in class org.openspml.message.Schema

setFilter(Filter) - Method in class org.openspml.message.SearchRequest

setFinalSubstring(String) - Method in class org.openspml.message.FilterTerm

setHeader(String) - Method in class org.openspml.client.SpmlClient

Set an optional SOAP Header.

setHeader(String) - Method in class org.openspml.client.SOAPClient

setId(String) - Method in class org.openspml.message.SchemaIdentifier

setId(String) - Method in class org.openspml.message.OperationIdentifier

setId(String) - Method in class org.openspml.message.Identifier

setId(String) - Method in class org.openspml.message.ProviderIdentifier

setIdentifier(Identifier) - Method in class org.openspml.message.SpmlRequest

Sets the target object identifier.

setIdentifier(Identifier) - Method in class org.openspml.message.AddResponse

Set the identifier of the new object.

setIdentifier(Identifier) - Method in class org.openspml.message.SearchResult

setIdentifier(String) - Method in class org.openspml.message.SpmlRequest

Sets the target object identifier.

setIdentifier(String) - Method in class org.openspml.message.AddResponse

Set the identifier of the new object as a string.

setIdentifier(String) - Method in class org.openspml.message.SearchResult

setInitialSubstring(String) - Method in class org.openspml.message.FilterTerm

setLength(int) - Method in class org.openspml.util.XmlBuffer

setMajorVersion(String) - Method in class org.openspml.message.Schema

setMatchingRule(String) - Method in class org.openspml.message.FilterTerm

setMemeberAttributes(List) - Method in class org.openspml.message.ObjectClassDefinition

setMinorVersion(String) - Method in class org.openspml.message.Schema

setModifications(List) - Method in class org.openspml.message.ModifyRequest

setModifications(List) - Method in class org.openspml.message.ModifyResponse

setModifications(Map) - Method in class org.openspml.message.ModifyRequest

Specify the modifications as a map of name/value pairs.

setMonitor(SOAPMonitor) - Method in class org.openspml.client.SpmlClient

Install a SOAP message monitor.

setMonitor(SOAPMonitor) - Method in class org.openspml.client.SOAPClient

setMulti(boolean) - Method in class org.openspml.message.AttributeDefinition

setName(String) - Method in class org.openspml.message.FilterTerm

setName(String) - Method in class org.openspml.message.AttributeDefinition

setName(String) - Method in class org.openspml.message.Attribute

setName(String) - Method in class org.openspml.message.ObjectClassDefinition

setName(String) - Method in class org.openspml.message.AttributeDefinitionReference

setName(String) - Method in class org.openspml.message.ObjectClassDefinitionReference

setNamespace(String) - Method in class org.openspml.util.XmlBuffer

setObjectClass(String) - Method in class org.openspml.message.AddRequest

Sets the class of the object being added.

setObjectClassDefinitions(List) - Method in class org.openspml.message.Schema

setOnErrorResume(boolean) - Method in class org.openspml.message.BatchRequest

Specify whether the batch should terminate as soon as one request has an error, or whether the batch should continue.

setOperands(List) - Method in class org.openspml.message.FilterTerm

setOperation(String) - Method in class org.openspml.message.FilterTerm

setOperation(String) - Method in class org.openspml.message.Modification

setOperationalAttribute(Attribute) - Method in class org.openspml.message.