Supported operation codes:
CREATE:Create a new Entry
| READ:Return a single Entry
| UPDATE:Update a single Entry
| DELETE:Delete a single Entry
| SEARCH:Search for and return multiple Entries
| PWDCHANGE:Change an Entry's password, with provided value
| PWDRESETChange an Entry's password, system generated
| PWDFORGOT:Forgotten password questions/answers process
Used at all Tiers in the Project.OpenPTKLogFormatter - Class in org.openptk.logging OpenPTKLogFormatter() -
Constructor for class org.openptk.logging.OpenPTKLogFormatter
OperationException - Exception in org.openptk.exceptionProvision Framework Operation related Exceptions.OperationException(String) -
Constructor for exception org.openptk.exception.OperationException
Create a new OperationException, use the provided message.
OperationException(Throwable) -
Constructor for exception org.openptk.exception.OperationException
Create a new OperationException, use the provided Exception.
Operations - Class in org.openptk.spi.operations Operations() -
Constructor for class org.openptk.spi.operations.Operations
OperationsIF - Interface in org.openptk.spi.operations OperationsType - Enum in org.openptk.spi.operations org.openptk.api - package org.openptk.apiProvides the classes necessary to call from Java applications into the Project OpenPTK Framework.org.openptk.connection - package org.openptk.connectionProvides the foundation and abstract classes that are used to establish
a connection to the OpenPTK Serverorg.openptk.connection.jersey - package org.openptk.connection.jerseyProvides an implementation of the abstract Connection class using the Jersey
(JAXRS) Client API.org.openptk.crypto - package org.openptk.cryptoProvides the classes necessary for OpenPTK cryptographic functions.org.openptk.exception - package org.openptk.exceptionContains exception classes thrown by the Project OpenPTK Framework and API classes.org.openptk.logging - package org.openptk.loggingProvides centralized Logging service to be used by all OpenPTK objects to log messages of different logging levels.org.openptk.plugin - package org.openptk.pluginInterface and abstract class to support plug-ins.org.openptk.spi - package org.openptk.spiInterfaces and abstract classes that provide access to the Service Provider Interfaceorg.openptk.spi.operations - package org.openptk.spi.operationsInterfaces, types and abstract classes which define the Operations that can be
associated and implemented by a Service.org.openptk.structure - package org.openptk.structureProvides the classes necessary for OpenPTK data representations, Strucutres, and conversion routines, Converters.org.openptk.util - package org.openptk.utilProvides the classes necessary for OpenPTK utility functions like String, ID, Timing and Random utilities.Output - Class in org.openptk.apiThe Output object contains the State/Status and Results of an Operation.Output() -
Constructor for class org.openptk.api.Output
Creates a new Ouput object.
Output(Output) -
Constructor for class org.openptk.api.Output
Creates a new Output that is a copy of the specified Output.
P
- PAD -
Static variable in class org.openptk.structure.Converter
-
- pad(int, String) -
Method in class org.openptk.structure.Converter
- Returns a String built by repeating the String.
- PARAM_CLIENTCRED -
Static variable in interface org.openptk.connection.ConnectionIF
-
- PARAM_CLIENTID -
Static variable in interface org.openptk.connection.ConnectionIF
-
- PARAM_PASSWORD -
Static variable in interface org.openptk.connection.ConnectionIF
-
- PARAM_TOKEN -
Static variable in interface org.openptk.connection.ConnectionIF
-
- PARAM_USER -
Static variable in interface org.openptk.connection.ConnectionIF
-
- PASSWORD -
Static variable in interface org.openptk.api.Constants
-
- PBECrypto - Class in org.openptk.crypto
- Class extends Crypto (abstract) class and provides a
Password Based Encryption (PBE) implementation.
- PBECrypto(String, String) -
Constructor for class org.openptk.crypto.PBECrypto
- Create a CryptoIF instance that uses Password Based Encryption.
- PKG_CONNECTION -
Static variable in interface org.openptk.connection.SetupIF
-
- PKG_CONVERTER -
Static variable in interface org.openptk.connection.SetupIF
-
- PlainConverter - Class in org.openptk.structure
-
This class supports the conversion of StructureIF data TO
Plain Text.
- PlainConverter() -
Constructor for class org.openptk.structure.PlainConverter
- Create a new PlainConverter object.
- Plugin - Class in org.openptk.plugin
-
- Plugin() -
Constructor for class org.openptk.plugin.Plugin
-
- PluginException - Exception in org.openptk.exception
-
- PluginException(String) -
Constructor for exception org.openptk.exception.PluginException
- Create a new ServiceException, use the provided message.
- PluginException(Throwable) -
Constructor for exception org.openptk.exception.PluginException
- Create a new ServiceException, use the provided Exception.
- PluginIF - Interface in org.openptk.plugin
-
- postExecute(RequestIF, ResponseIF) -
Method in class org.openptk.spi.operations.Operations
-
- postExecute(RequestIF, ResponseIF) -
Method in interface org.openptk.spi.operations.OperationsIF
-
- preExecute(RequestIF, ResponseIF) -
Method in class org.openptk.spi.operations.Operations
-
- preExecute(RequestIF, ResponseIF) -
Method in interface org.openptk.spi.operations.OperationsIF
-
- processClientStructure(StructureIF) -
Method in class org.openptk.connection.Connection
- Process the Client Structure that comes from the server.
- PROP_ATTRIBUTE_EMPTY_REMOVE -
Static variable in interface org.openptk.spi.operations.OperationsIF
-
- PROP_CASE -
Static variable in class org.openptk.util.RandomData
-
- PROP_CHAR_SET -
Static variable in class org.openptk.util.RandomData
-
- PROP_CHILDREN -
Static variable in interface org.openptk.structure.ConverterIF
-
- PROP_CLASSNAME -
Static variable in interface org.openptk.logging.LoggingIF
-
- PROP_CONNECTION_CLIENTID -
Static variable in interface org.openptk.connection.SetupIF
-
- PROP_CONNECTION_MODE -
Static variable in interface org.openptk.connection.SetupIF
-
- PROP_CONNECTION_PASSWORD -
Static variable in interface org.openptk.connection.SetupIF
-
- PROP_CONNECTION_SESSIONID -
Static variable in interface org.openptk.connection.SetupIF
-
- PROP_CONNECTION_SHAREDSECRET -
Static variable in interface org.openptk.connection.SetupIF
-
- PROP_CONNECTION_TOKEN -
Static variable in interface org.openptk.connection.SetupIF
-
- PROP_CONNECTION_URI -
Static variable in interface org.openptk.connection.SetupIF
-
- PROP_CONNECTION_USER -
Static variable in interface org.openptk.connection.SetupIF
-
- PROP_COOKIE_NAME -
Static variable in interface org.openptk.connection.ConnectionIF
-
- PROP_DEBUG -
Static variable in interface org.openptk.connection.SetupIF
-
- PROP_DRIVER -
Static variable in interface org.openptk.spi.operations.OperationsIF
-
- PROP_FILENAME -
Static variable in interface org.openptk.logging.LoggingIF
-
- PROP_FILENAME -
Static variable in interface org.openptk.spi.operations.OperationsIF
-
- PROP_LOGFILE -
Static variable in interface org.openptk.connection.SetupIF
-
- PROP_NAMEVALUE -
Static variable in interface org.openptk.structure.ConverterIF
-
- PROP_PROTOCOL -
Static variable in interface org.openptk.spi.operations.OperationsIF
-
- PROP_PROXY_HOST -
Static variable in interface org.openptk.spi.operations.OperationsIF
-
- PROP_PROXY_PORT -
Static variable in interface org.openptk.spi.operations.OperationsIF
-
- PROP_RESET_PASSWORD_LENGTH -
Static variable in interface org.openptk.spi.operations.OperationsIF
-
- PROP_SIZE -
Static variable in class org.openptk.util.RandomData
-
- PROP_TYPE -
Static variable in class org.openptk.util.RandomData
-
- PROP_URI_CLIENTS -
Static variable in interface org.openptk.connection.ConnectionIF
-
- PROP_URI_CONTEXTS -
Static variable in interface org.openptk.connection.ConnectionIF
-
- PROP_URI_LOGIN -
Static variable in interface org.openptk.connection.ConnectionIF
-
- PROP_URI_LOGOUT -
Static variable in interface org.openptk.connection.ConnectionIF
-
- PROP_URL -
Static variable in interface org.openptk.spi.operations.OperationsIF
-
- PROP_URL -
Static variable in interface org.openptk.spi.ServiceIF
-
- PROP_USER_NAME -
Static variable in interface org.openptk.spi.operations.OperationsIF
-
- PROP_USER_NAME_ENCRYPTED -
Static variable in interface org.openptk.spi.operations.OperationsIF
-
- PROP_USER_PASSWORD -
Static variable in interface org.openptk.spi.operations.OperationsIF
-
- PROP_USER_PASSWORD_ENCRYPTED -
Static variable in interface org.openptk.spi.operations.OperationsIF
-
- PROP_VALUE -
Static variable in interface org.openptk.structure.ConverterIF
-
- ProvisionException - Exception in org.openptk.exception
- A generic ProvisionException.
- ProvisionException(String) -
Constructor for exception org.openptk.exception.ProvisionException
- Create a new ProvisionException, use the provided message.
- ProvisionException(Throwable) -
Constructor for exception org.openptk.exception.ProvisionException
- Create a new ProvisionException, use the provided Exception.
- ptkadmin - Class in org.openptk.util
-
- ptkadmin() -
Constructor for class org.openptk.util.ptkadmin
-
- put(LoggingLevel, String) -
Method in class org.openptk.logging.AtomicLogger
-
- put(String) -
Method in interface org.openptk.logging.LoggingIF
-
- put(LoggingLevel, String) -
Method in interface org.openptk.logging.LoggingIF
-
- put(String) -
Method in class org.openptk.logging.SysoutLogger
- Prints the message to standard output using the INFO level.
- put(LoggingLevel, String) -
Method in class org.openptk.logging.SysoutLogger
- Prints the message to standard output using the LoggingLevel type passed.
Q
- Query - Class in org.openptk.api
- The Query class is used to define simple and complex queries.
- Query() -
Constructor for class org.openptk.api.Query
- Create a new complex Query with a default Type of "AND".
- Query(Query) -
Constructor for class org.openptk.api.Query
- Create a new simple or complex Query from an existing Query
The specified Query will be copied and it's data will be added
to the new Query.
- Query(Query.Type) -
Constructor for class org.openptk.api.Query
- Create a new simple Query with the specified Type.
- Query(Query.Type, Query) -
Constructor for class org.openptk.api.Query
- Create a new complex Query with the specified Type and adds the
provided Query.
- Query(Query.Type, String, String) -
Constructor for class org.openptk.api.Query
- Create a new simple Query using the provided information.
- Query(String, String, String) -
Constructor for class org.openptk.api.Query
- Create a new simple Query using the provided information.
- Query(Query.Type, List<Query>) -
Constructor for class org.openptk.api.Query
- Create a new complex Query using the List of Queries.
- Query.Type - Enum in org.openptk.api
-
- QueryBuilder - Class in org.openptk.api
-
- QueryBuilder() -
Constructor for class org.openptk.api.QueryBuilder
-
- QueryBuilderIF - Interface in org.openptk.api
-
- QueryConverter - Class in org.openptk.spi
-
- QueryConverter() -
Constructor for class org.openptk.spi.QueryConverter
-
- QueryConverter(Query) -
Constructor for class org.openptk.spi.QueryConverter
-
- QueryConverterIF - Interface in org.openptk.spi
-
- QueryException - Exception in org.openptk.exception
- Provision Framework Query related Exceptions.
- QueryException(String) -
Constructor for exception org.openptk.exception.QueryException
- Create a new QueryException, use the provided message.
- QueryException(Throwable) -
Constructor for exception org.openptk.exception.QueryException
- Create a new QueryException, use the provided Exception.
- QUOTE -
Static variable in class org.openptk.structure.Converter
-
R
- RandomData - Class in org.openptk.util
- Methods that generate random data.
- removeAttribute(String) -
Method in class org.openptk.api.Element
- Remove the named Attribute.
- removeAttribute(String) -
Method in interface org.openptk.api.ElementIF
- Remove the named Attribute.
- removeProperty(String) -
Method in class org.openptk.api.Element
- Remove the named Property
- removeProperty(String) -
Method in interface org.openptk.api.ElementIF
- Remove the named Property
- removeQuery() -
Method in class org.openptk.api.Input
- Removes the Input's Query.
- RESOURCE_SESSION -
Static variable in interface org.openptk.connection.ConnectionIF
-
- RESOURCES -
Static variable in interface org.openptk.api.Constants
-
- RESPONSE_DESC -
Static variable in class org.openptk.spi.operations.Operations
-
- RESPONSE_DESC -
Variable in class org.openptk.spi.Service
-
- ResponseException - Exception in org.openptk.exception
-
- ResponseException(String) -
Constructor for exception org.openptk.exception.ResponseException
- Create a new ResponseException, use the provided message.
- ResponseException(Throwable) -
Constructor for exception org.openptk.exception.ResponseException
- Create a new ResponseException, use the provided Exception.
- RestartService - Class in org.openptk.spi
-
- RestartService() -
Constructor for class org.openptk.spi.RestartService
-
S
- scaleCropImage(byte[], int, int, String) -
Static method in class org.openptk.util.Media
- Scale and Crop the image (byte[]) to the specified size (width and height).
- SecurityException - Exception in org.openptk.exception
-
- SecurityException(String) -
Constructor for exception org.openptk.exception.SecurityException
- Create a new SecurityException, use the provided message.
- SecurityException(Throwable) -
Constructor for exception org.openptk.exception.SecurityException
- Create a new SecurityException, use the provided Exception.
- SEPARATOR -
Static variable in class org.openptk.structure.Converter
-
- serialVersionUID -
Static variable in exception org.openptk.exception.ActionException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.AuthenticationException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.AuthorizationException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.ConfigurationException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.ConnectionException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.ConverterException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.CryptoException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.EngineException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.FunctionException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.OperationException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.PluginException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.ProvisionException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.QueryException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.ResponseException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.SecurityException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.ServiceException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.StructureException
-
- serialVersionUID -
Static variable in exception org.openptk.exception.TypeException
-
- Service - Class in org.openptk.spi
-
- Service() -
Constructor for class org.openptk.spi.Service
-
- ServiceException - Exception in org.openptk.exception
- Provision Framework Service related Exceptions.
- ServiceException(String) -
Constructor for exception org.openptk.exception.ServiceException
- Create a new ServiceException, use the provided message.
- ServiceException(Throwable) -
Constructor for exception org.openptk.exception.ServiceException
- Create a new ServiceException, use the provided Exception.
- ServiceIF - Interface in org.openptk.spi
-
- SESSION_ID -
Static variable in interface org.openptk.connection.SetupIF
-
- SESSIONID -
Static variable in interface org.openptk.api.Constants
-
- setAccess(AttributeIF.Access) -
Method in class org.openptk.api.Attribute
- Set the Attributes Access level.
- setAccess(String) -
Method in class org.openptk.api.Attribute
- Set the Attribute Access level.
- setAccess(AttributeIF.Access) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes Access level.
- setAccess(String) -
Method in interface org.openptk.api.AttributeIF
- Set the Attribute Access level.
- setAccess(AttributeIF.Access) -
Method in class org.openptk.api.Input
- Set the Input's access level.
- setAccess(String) -
Method in class org.openptk.api.Input
- Set the Input's access level.
- setAllowMultivalue(boolean) -
Method in class org.openptk.api.Attribute
- Set the flag to define if the Attribute allows multivalues.
- setAllowMultivalue(boolean) -
Method in interface org.openptk.api.AttributeIF
- Set the flag to define if the Attribute allows multivalues.
- setAssociation(Operation, ComponentIF) -
Method in class org.openptk.spi.Service
-
- setAssociation(Operation, ComponentIF) -
Method in interface org.openptk.spi.ServiceIF
-
- setAttrGroup(Operation, ComponentIF) -
Method in class org.openptk.spi.Service
-
- setAttrGroup(Operation, ComponentIF) -
Method in interface org.openptk.spi.ServiceIF
-
- setAttributes(Map<String, AttributeIF>) -
Method in class org.openptk.api.Element
- Set / Replace all Attributes with the new Collection.
- setAttributes(Map<String, AttributeIF>) -
Method in interface org.openptk.api.ElementIF
- Set / Replace all Attributes with the new Collection.
- setChild(int, StructureIF) -
Method in class org.openptk.structure.Structure
- Sets / Replaces a specific Child with the provided Structure.
- setChild(int, StructureIF) -
Method in interface org.openptk.structure.StructureIF
- Sets / Replaces a specific Child with the provided Structure.
- setContext(ContextIF) -
Method in class org.openptk.spi.Service
-
- setContext(ContextIF) -
Method in interface org.openptk.spi.ServiceIF
-
- setContextId(String) -
Method in class org.openptk.connection.Connection
- Set the "current" Context Id.
- setContextId(String) -
Method in interface org.openptk.connection.ConnectionIF
- Set the "current" Context Id.
- setCrypto(String, CryptoIF) -
Static method in class org.openptk.crypto.Encryptor
-
- setCrypto(CryptoIF) -
Static method in class org.openptk.crypto.Encryptor
-
- setDebug(boolean) -
Method in class org.openptk.connection.Connection
- Set the debug flag.
- setDebug(boolean) -
Method in interface org.openptk.connection.ConnectionIF
- Set the debug flag.
- setDescription(String) -
Method in class org.openptk.api.Element
- Set the Description, a generic value that can be defined.
- setDescription(String) -
Method in interface org.openptk.api.ElementIF
- Set the Description, a generic value that can be defined.
- setEnabled(Operation, boolean) -
Method in class org.openptk.spi.operations.Operations
-
- setEnabled(Operation, boolean) -
Method in interface org.openptk.spi.operations.OperationsIF
-
- setEncrypted(boolean) -
Method in class org.openptk.api.Attribute
- Set the flag to define if the Attribute value is encrypted.
- setEncrypted(boolean) -
Method in interface org.openptk.api.AttributeIF
- Set the flag to define if the Attribute value is encrypted.
- setError(boolean) -
Method in class org.openptk.api.Element
- Flag to set if there is an Error.
- setError(boolean) -
Method in interface org.openptk.api.ElementIF
- Flag to set if there is an Error.
- setFw2SrvcNames(Operation, Map<String, String>) -
Method in class org.openptk.spi.Service
-
- setFw2SrvcNames(Operation, Map<String, String>) -
Method in interface org.openptk.spi.ServiceIF
-
- setId(String) -
Method in class org.openptk.crypto.Crypto
-
- setId(String) -
Method in interface org.openptk.crypto.CryptoIF
-
- setImplemented(Operation, boolean) -
Method in class org.openptk.spi.operations.Operations
-
- setInternal(boolean) -
Method in class org.openptk.api.Query
- Flag the Query as internal [ true | false ].
- setKey(String) -
Method in class org.openptk.api.Element
- Sets the name of the attribute which is defined as the unique
primary key.
- setKey(String) -
Method in interface org.openptk.api.ElementIF
- Sets the name of the attribute which is defined as the unique
primary key.
- setKey(Operation, String) -
Method in class org.openptk.spi.Service
-
- setKey(Operation, String) -
Method in interface org.openptk.spi.ServiceIF
-
- setLogger(LoggingIF) -
Static method in class org.openptk.logging.Logger
- Add the logging instance to the Logger using a particular
name to refer to it, and subsequently get or log messages to later.
- setMultiValued(Boolean) -
Method in class org.openptk.api.Attribute
- Set the flag for a value, is it multivalued.
- setName(String) -
Method in class org.openptk.api.Query
- Set the attribute name.
- setName(String) -
Method in class org.openptk.structure.Structure
- Set the Structure's name.
- setName(String) -
Method in interface org.openptk.structure.StructureIF
- Set the Structure's name.
- setOperation(Operation, OperationsIF) -
Method in class org.openptk.spi.Service
-
- setOperation(Operation, OperationsIF) -
Method in interface org.openptk.spi.ServiceIF
-
- setOperAttr(Operation, ComponentIF) -
Method in class org.openptk.spi.Service
-
- setOperAttr(Operation, ComponentIF) -
Method in interface org.openptk.spi.ServiceIF
-
- setOperProps(Operation, Properties) -
Method in class org.openptk.spi.Service
-
- setOperProps(Operation, Properties) -
Method in interface org.openptk.spi.ServiceIF
-
- setParent(StructureIF) -
Method in class org.openptk.structure.Structure
- Set the Structure's parent.
- setParent(StructureIF) -
Method in interface org.openptk.structure.StructureIF
- Set the Structure's parent.
- setProperties(Properties) -
Method in class org.openptk.api.Attribute
- Sets / Replaces the Attributes Properties.
- setProperties(Properties) -
Method in interface org.openptk.api.AttributeIF
- Sets / Replaces the Attributes Properties.
- setProperties(Properties) -
Method in class org.openptk.api.Element
- Set/Replace the properties with the new Properties.
- setProperties(Properties) -
Method in interface org.openptk.api.ElementIF
- Set/Replace the properties with the new Properties.
- setProperty(String, String) -
Method in class org.openptk.api.Attribute
- Add the key / value as a Property to the Attribute.
- setProperty(String, String) -
Method in interface org.openptk.api.AttributeIF
- Add the key / value as a Property to the Attribute.
- setProperty(String, String) -
Method in class org.openptk.api.Element
- Set a property using the key and value.
- setProperty(String, String) -
Method in interface org.openptk.api.ElementIF
- Set a property using the key and value.
- setQuery(Query) -
Method in class org.openptk.api.Input
- Set the Input's Query.
- setQuery(Query) -
Method in class org.openptk.spi.QueryConverter
-
- setQuery(Query) -
Method in interface org.openptk.spi.QueryConverterIF
-
- setQuery(Operation, Query) -
Method in class org.openptk.spi.Service
-
- setQuery(Operation, Query) -
Method in interface org.openptk.spi.ServiceIF
-
- setQueryList(List<Query>) -
Method in class org.openptk.api.Query
- Set / replace the List of sub-queries.
- setReadOnly(boolean) -
Method in class org.openptk.api.Attribute
- Set the Attributes read only flag.
- setReadOnly(boolean) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes read only flag.
- setRequired(boolean) -
Method in class org.openptk.api.Attribute
- Set the Attributes required flag.
- setRequired(boolean) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes required flag.
- setService(ServiceIF) -
Method in class org.openptk.spi.operations.Operations
-
- setService(ServiceIF) -
Method in interface org.openptk.spi.operations.OperationsIF
-
- setServiceName(String) -
Method in class org.openptk.api.Query
- Set the Service attribute name, as known by the Service, in the Query
This method is not to be used by OpenPTK applications.
- setSessionChanged(boolean) -
Method in class org.openptk.connection.Connection
-
- setSessionId(String) -
Method in class org.openptk.connection.Connection
-
- setSortAttributes(List<String>) -
Method in class org.openptk.spi.Service
-
- setSortAttributes(List<String>) -
Method in interface org.openptk.spi.ServiceIF
-
- setSrvc2FwNames(Operation, Map<String, String>) -
Method in class org.openptk.spi.Service
-
- setSrvc2FwNames(Operation, Map<String, String>) -
Method in interface org.openptk.spi.ServiceIF
-
- setState(State) -
Method in class org.openptk.api.Attribute
- Set the Attributes State.
- setState(State) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes State.
- setState(State) -
Method in class org.openptk.api.Element
- Set the State.
- setState(State) -
Method in interface org.openptk.api.ElementIF
- Set the state, see State for valid states.
- setState(State) -
Method in class org.openptk.structure.Structure
- Set the Structure State.
- setState(State) -
Method in interface org.openptk.structure.StructureIF
- Set the Structure's State.
- setStatus(String) -
Method in class org.openptk.api.Element
- Set the status
a general purpose piece of information that
can be used to store arbitrary information, typically used to
store application level status information.
- setStatus(String) -
Method in interface org.openptk.api.ElementIF
- Set the status
a general purpose piece of information that
can be used to store arbitrary information, typically used to
store application level status information.
- setStructInfo(String, ElementIF) -
Method in class org.openptk.structure.Converter
- Set Structure Information using the provided Id.
- setStructInfo(String, ElementIF) -
Method in interface org.openptk.structure.ConverterIF
- Set Structure Information using the provided Id.
- setTimeout(Operation, int) -
Method in class org.openptk.spi.Service
-
- setTimeout(Operation, int) -
Method in interface org.openptk.spi.ServiceIF
-
- setType(DataType) -
Method in class org.openptk.api.Attribute
- Set the Attributes type (enum).
- setType(DataType) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes type (enum).
- setType(String) -
Method in class org.openptk.api.Query
- Set the Query Type, using the String representaion for the Type.
- setType(Query.Type) -
Method in class org.openptk.api.Query
- Set the Query's Type.
- setType(OperationsType) -
Method in class org.openptk.spi.operations.Operations
-
- setType(OperationsType) -
Method in interface org.openptk.spi.operations.OperationsIF
-
- setUniqueId(String) -
Method in class org.openptk.api.Element
- Set the Unique ID to the String
- setUniqueId(Integer) -
Method in class org.openptk.api.Element
- Set the Unique ID to the Integer
- setUniqueId(Long) -
Method in class org.openptk.api.Element
- Set the Unique ID to the Long
- setUniqueId(ElementIF) -
Method in class org.openptk.api.Element
-
- setUniqueId(String) -
Method in interface org.openptk.api.ElementIF
- Set the Unique ID
a generic identifier, this should be a unique value.
- setUniqueId(Integer) -
Method in interface org.openptk.api.ElementIF
-
- setUniqueId(Long) -
Method in interface org.openptk.api.ElementIF
-
- setUniqueId(ElementIF) -
Method in interface org.openptk.api.ElementIF
-
- Setup - Class in org.openptk.connection
-
Boot-straps the connection to the Server.
- Setup(String) -
Constructor for class org.openptk.connection.Setup
-
Create a new Setup object using the specified Property file.
- SetupIF - Interface in org.openptk.connection
-
- setUseNamespace(boolean) -
Method in class org.openptk.api.Query
- Set the value [ true | false ] for this flag.
- setValue(Object) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to the single Object.
- setValue(Object[]) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to the Object array.
- setValue(boolean) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to a single Boolean.
- setValue(boolean[]) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to a Boolean array.
- setValue(Boolean) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to a single Boolean.
- setValue(Boolean[]) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to a Boolean array.
- setValue(int) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to a single Integer.
- setValue(int[]) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to a Integer array.
- setValue(Integer) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to a single Integer.
- setValue(Integer[]) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to a Integer array.
- setValue(Long) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to a single Long.
- setValue(Long[]) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to a Long array.
- setValue(String) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to a single String.
- setValue(String[]) -
Method in class org.openptk.api.Attribute
- Set the Attributes value to a String array.
- setValue(Object) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes value to the single Object.
- setValue(Object[]) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes value to the Object array.
- setValue(boolean) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes value to a single Boolean.
- setValue(boolean[]) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes value to a Boolean array.
- setValue(Boolean) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes value to a single Boolean.
- setValue(Boolean[]) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes value to a Boolean array.
- setValue(int) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes value to a single Integer.
- setValue(int[]) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes value to a Integer array.
- setValue(Integer) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes value to a single Integer.
- setValue(Integer[]) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes value to a Integer array.
- setValue(String) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes value to a single String.
- setValue(String[]) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes value to a String array.
- setValue(String) -
Method in class org.openptk.api.Query
- Set the attribute value.
- setVirtual(boolean) -
Method in class org.openptk.api.Attribute
- Set the Attributes virtual flag.
- setVirtual(boolean) -
Method in interface org.openptk.api.AttributeIF
- Set the Attributes virtual flag.
- shutdown() -
Method in class org.openptk.plugin.Plugin
-
- shutdown() -
Method in interface org.openptk.plugin.PluginIF
-
- shutdown() -
Method in class org.openptk.spi.operations.Operations
-
- shutdown() -
Method in interface org.openptk.spi.operations.OperationsIF
-
- shutdown() -
Method in class org.openptk.spi.Service
-
- shutdown() -
Method in interface org.openptk.spi.ServiceIF
-
- SimpleLogger - Class in org.openptk.logging
-
- SimpleLogger(String) -
Constructor for class org.openptk.logging.SimpleLogger
- SimpleLogger - Create a new simple logger with a file to be written to.
- startTimer(String) -
Static method in class org.openptk.util.Timer
- StartTimer will capture the time this method is called and store it in
a timer named by the passed argument timerName.
- startup() -
Method in class org.openptk.plugin.Plugin
-
- startup() -
Method in interface org.openptk.plugin.PluginIF
-
- startup() -
Method in class org.openptk.spi.operations.LoopbackOperations
-
- startup() -
Method in class org.openptk.spi.operations.Operations
-
- startup() -
Method in interface org.openptk.spi.operations.OperationsIF
-
- startup() -
Method in class org.openptk.spi.Service
-
- startup() -
Method in interface org.openptk.spi.ServiceIF
-
- State - Enum in org.openptk.api
-
- stopTimer(String) -
Static method in class org.openptk.util.Timer
- StopTimer will capture the time this method is called and return the
elapsed time in ms since the corresponding StartTimer was called for
that timerName.
- STRING_ENCODING -
Variable in class org.openptk.crypto.Crypto
-
- stringToArray(String, String) -
Static method in class org.openptk.util.StringUtil
- Process the String into a String Array
Not using String.split because we want to handle "empty/blank" sub-strings
The array will not contain empty strings, they will be skipped
The returned String Array will always be non-null, may have zero elements.
- StringUtil - Class in org.openptk.util
-
- Structure - Class in org.openptk.structure
- The abstract base class for a Structure.
- Structure(String) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name.
- Structure(String, String) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and value.
- Structure(String, List<String>) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and List of values.
- Structure(String, String[]) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and Array of values.
- Structure(String, int) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and value.
- Structure(String, Integer) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and value.
- Structure(String, Integer[]) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and array of values.
- Structure(String, long) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and value.
- Structure(String, Long) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and value.
- Structure(String, Long[]) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and array of values.
- Structure(String, boolean) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and value.
- Structure(String, Boolean) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and value.
- Structure(String, Boolean[]) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and array of values.
- Structure(String, Object) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and value.
- Structure(String, Object[]) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provided name and array of values.
- Structure(String, StructureIF) -
Constructor for class org.openptk.structure.Structure
- Create a new Structure using the provide name and child Structure.
- StructureException - Exception in org.openptk.exception
- Provision Framework Operation related Exceptions.
- StructureException(String) -
Constructor for exception org.openptk.exception.StructureException
- Create a new ConverterException, use the provided message.
- StructureException(Throwable) -
Constructor for exception org.openptk.exception.StructureException
- Create a new ConverterException, use the provided Exception.
- StructureIF - Interface in org.openptk.structure
- The Structure (interface and classes) is a generic class that supports
two main features.
- StructureType - Enum in org.openptk.structure
- Valid Structure Types.
- SysoutLogger - Class in org.openptk.logging
- Logger implementation that logs all messages to standard system output.
- SysoutLogger() -
Constructor for class org.openptk.logging.SysoutLogger
-
T
- throwServiceException(Throwable) -
Method in class org.openptk.spi.Service
-
- throwServiceException(String) -
Method in class org.openptk.spi.Service
-
- Timer - Class in org.openptk.util
- Singleton class which will hold timers that can be used by any calling
class to time start/stop timers and report on timings
- toFw(Operation, String[]) -
Method in class org.openptk.spi.Service
-
- toFw(Operation, String[]) -
Method in interface org.openptk.spi.ServiceIF
-
- TOKEN -
Static variable in interface org.openptk.api.Constants
-
- toSrvc(Operation, String[]) -
Method in class org.openptk.spi.Service
-
- toSrvc(Operation, String[]) -
Method in interface org.openptk.spi.ServiceIF
-
- toString() -
Method in class org.openptk.api.Attribute
- Get a String that represents the Attribute.
- toString() -
Method in class org.openptk.api.Element
- Information about the Element, summarize data into a String.
- toString() -
Method in class org.openptk.api.Query
- Returns a String that represents the Query
Supports both simple and complex queries.
- toString() -
Method in class org.openptk.structure.Structure
-
- toXML() -
Method in class org.openptk.api.Query
- Returns an XML structure that represents the Query
Supports both simple and complex queries.
- TRANS_FW_SRVC -
Static variable in class org.openptk.spi.operations.Operations
-
- TRANS_SRVC_FW -
Static variable in class org.openptk.spi.operations.Operations
-
- TripleDESCrypto - Class in org.openptk.crypto
-
- TripleDESCrypto() -
Constructor for class org.openptk.crypto.TripleDESCrypto
- Creates a CryptoIF instance
using the PBEWithMD5AndripleDES cipher with a pre-defined pass phrase.
- TripleDESCrypto(String) -
Constructor for class org.openptk.crypto.TripleDESCrypto
- Creates a CryptoIF instance using the PBEWithMD5AndTripleDES cipher.
- TYPE_ALPHA -
Static variable in class org.openptk.util.RandomData
-
- TYPE_BOTH -
Static variable in class org.openptk.util.RandomData
-
- TYPE_NUMERIC -
Static variable in class org.openptk.util.RandomData
-
- TypeException - Exception in org.openptk.exception
- Provision Framework Operation related Exceptions.
- TypeException(String) -
Constructor for exception org.openptk.exception.TypeException
- Create a new TypeException, use the provided message.
- TypeException(Throwable) -
Constructor for exception org.openptk.exception.TypeException
- Create a new TypeException, use the provided Exception.
U
- UniqueId - Class in org.openptk.util
-
- updateOutputFromReadStructure(Output, StructureIF) -
Method in class org.openptk.connection.Connection
- Update the StructureIF from the Read response (Structure).
- updateOutputFromSearchStructure(Output, StructureIF) -
Method in class org.openptk.connection.Connection
- Update Output from the Search response (Structure).
- updateQueryServiceName(Query) -
Method in class org.openptk.spi.operations.Operations
-
- URI_LOGIN -
Static variable in interface org.openptk.connection.SetupIF
-
- URI_LOGOUT -
Static variable in interface org.openptk.connection.SetupIF
-
- URI_RESOURCES -
Static variable in interface org.openptk.connection.SetupIF
-
- urlDecode(String) -
Method in class org.openptk.connection.Connection
- URL Decode a string.
- urlEncode(String) -
Method in class org.openptk.connection.Connection
- URL Encode a string.
- useConnection(String) -
Method in class org.openptk.connection.Setup
-
- useConnection(String) -
Method in interface org.openptk.connection.SetupIF
-
- USER -
Static variable in interface org.openptk.api.Constants
-
V
- validate(String, byte[]) -
Static method in class org.openptk.util.Digest
-
- validate(String, String) -
Static method in class org.openptk.util.Digest
-
- validateRequest(RequestIF, ResponseIF) -
Method in class org.openptk.spi.Service
-
- VALUE_CHILDREN_DISCRETE -
Static variable in interface org.openptk.structure.ConverterIF
-
- VALUE_CHILDREN_LIST -
Static variable in interface org.openptk.structure.ConverterIF
-
- VALUE_NAMEVALUE_COLLAPSED -
Static variable in interface org.openptk.structure.ConverterIF
-
- VALUE_NAMEVALUE_EXPANDED -
Static variable in interface org.openptk.structure.ConverterIF
-
- VALUE_VALUE_MULTI -
Static variable in interface org.openptk.structure.ConverterIF
-
- VALUE_VALUE_SINGLE -
Static variable in interface org.openptk.structure.ConverterIF
-
- valueOf(String) -
Static method in enum org.openptk.api.AttributeIF.Access
- Returns the enum constant of this type with the specified name.
- valueOf(String) -
Static method in enum org.openptk.api.DataType
- Returns the enum constant of this type with the specified name.
- valueOf(String) -
Static method in enum org.openptk.api.Opcode
- Returns the enum constant of this type with the specified name.
- valueOf(String) -
Static method in enum org.openptk.api.Query.Type
- Returns the enum constant of this type with the specified name.
- valueOf(String) -
Static method in enum org.openptk.api.State
- Returns the enum constant of this type with the specified name.
- valueOf(String) -
Static method in enum org.openptk.connection.ConnectionIF.Session
- Returns the enum constant of this type with the specified name.
- valueOf(String) -
Static method in enum org.openptk.logging.LoggingLevel
- Returns the enum constant of this type with the specified name.
- valueOf(String) -
Static method in enum org.openptk.spi.operations.OperationsType
- Returns the enum constant of this type with the specified name.
- valueOf(String) -
Static method in enum org.openptk.structure.ConverterType
- Returns the enum constant of this type with the specified name.
- valueOf(String) -
Static method in enum org.openptk.structure.StructureType
- Returns the enum constant of this type with the specified name.
- values() -
Static method in enum org.openptk.api.AttributeIF.Access
- Returns an array containing the constants of this enum type, in
the order they are declared.
- values() -
Static method in enum org.openptk.api.DataType
- Returns an array containing the constants of this enum type, in
the order they are declared.
- values() -
Static method in enum org.openptk.api.Opcode
- Returns an array containing the constants of this enum type, in
the order they are declared.
- values() -
Static method in enum org.openptk.api.Query.Type
- Returns an array containing the constants of this enum type, in
the order they are declared.
- values() -
Static method in enum org.openptk.api.State
- Returns an array containing the constants of this enum type, in
the order they are declared.
- values() -
Static method in enum org.openptk.connection.ConnectionIF.Session
- Returns an array containing the constants of this enum type, in
the order they are declared.
- values() -
Static method in enum org.openptk.logging.LoggingLevel
- Returns an array containing the constants of this enum type, in
the order they are declared.
- values() -
Static method in enum org.openptk.spi.operations.OperationsType
- Returns an array containing the constants of this enum type, in
the order they are declared.
- values() -
Static method in enum org.openptk.structure.ConverterType
- Returns an array containing the constants of this enum type, in
the order they are declared.
- values() -
Static method in enum org.openptk.structure.StructureType
- Returns an array containing the constants of this enum type, in
the order they are declared.
X
- XmlConverter - Class in org.openptk.structure
-
This class supports the conversion of StructureIF data TO and FROM
XML.
- XmlConverter() -
Constructor for class org.openptk.structure.XmlConverter
- Create a new XmlConverter object.
_
- _converter -
Variable in class org.openptk.connection.Connection
-
- _decoder -
Variable in class org.openptk.crypto.Crypto
-
- _decryptCipher -
Variable in class org.openptk.crypto.Crypto
-
- _emptyRemove -
Variable in class org.openptk.spi.operations.Operations
-
- _encoder -
Variable in class org.openptk.crypto.Crypto
-
- _encryptCipher -
Variable in class org.openptk.crypto.Crypto
-
- _uriClients -
Variable in class org.openptk.connection.Connection
-
- _uriContexts -
Variable in class org.openptk.connection.Connection
-
- _uriLogin -
Variable in class org.openptk.connection.Connection
-
- _uriLogout -
Variable in class org.openptk.connection.Connection
-
- _uriSessionInfo -
Variable in class org.openptk.connection.Connection
-
- _uriSubjects -
Variable in class org.openptk.connection.Connection
-
A B C D E F G H I J K L M N O P Q R S T U V X _
View/submit a bug or feature
For further API reference and developer documentation, see www.openptk.org.
That documentation contains more detailed, developer-targeted descriptions,
definitions of terms, workarounds, and working code examples.
Copyright (C) 2008-2012, Project OpenPTK. All Rights Reserved
|