Usage
Map the State enumerations to specific packages / classes
| State |
Client Tier |
Framework Tier |
Service Tier |
| AUTHENTICATED |
|
|
JDBC::JdbcOperations
JNDI::JndiOperations |
| ALLOWED |
|
BasicDecider::check |
|
| CONFIG |
|
|
|
| DENIED |
|
BasicDecider::check |
|
| DESTROYED |
|
|
|
| DISABLED |
|
|
|
| ERROR |
API::Output |
|
JDBC::JdbcOperations
JNDI::JndiOperations
SPML::SpmlOperations
SPML::SpmlSunOperations
SPML::Spml2Operations
SPML::Spml2SunOperations |
| FAILED |
API::Output |
|
JDBC::JdbcOperations
JNDI::JndiOperations
SPML::SpmlOperations
SPML::Spml2Operations |
| INVALID |
API::Output |
|
JNDI::JndiOperations
SPML::SpmlOperations
SPML::Spml2Operations |
| KEY |
|
|
|
| MULTI |
|
|
|
| NEW |
(default value for most usage) |
|
JDBC::JdbcOperations
JNDI::JndiOperations
SPML::SpmlOperations
SPML::SpmlSunOperations
SPML::Spml2Operations
SPML::Spml2SunOperations |
| NOTAUTHENTICATED |
API::Output
API::JerseyConnection |
|
JDBC::JdbcOperations
JNDI::JndiOperations |
| NOTEXIST |
API::Output |
|
JDBC::JdbcOperations
JNDI::JndiOperations |
| NOTDEFINED |
|
|
|
| NULL |
|
|
JDBC::JdbcOperations
JNDI::JndiOperations |
| OBJECT |
|
|
|
| OK |
|
|
|
| READY |
API::JerseyConnection |
|
JDBC::JdbcOperations
JNDI::JndiOperations
SPML::SpmlOperations
SPML::Spml2Operations |
| RUNNING |
|
|
|
| SUCCESS |
API::Output |
|
JDBC::JdbcOperations
JNDI::JndiOperations
SPML::SpmlOperations
SPML::SpmlSunOperations
SPML::SpeSpmlSunOperations
SPML::Spml2Operations
SPML::Spml2SunOperations |
| STOPPED |
|
|
|
| VALID |
|
|
|
| VALUE |
|
|
|
| WAITING |
|
|
|
Client Tier
API
org.openptk.api.Output
| State |
Condition |
| NEW |
Default state from creation (Element) |
| SUCCESS |
Set by ConnectionIF.execute() if HTTP Response equals:
200: OK
201: CREATED
204: NO_CONTENT |
| DENIED |
HTTP 401: UNAUTHORIZED |
| INVALID |
Set by ConnectionIF.execute() if HTTP Response equals:
400: BAD_REQUEST |
| NOTAUTHENTICATED |
Set by ConnectionIF.execute() if HTTP Response equals:
401: UNAUTHORIZED |
| FAILED |
Set by ConnectionIF.execute() if HTTP Response equals:
403: FORBIDDEN |
| NOTEXIST |
Set by ConnectionIF.execute() if HTTP Response equals:
404: NOT_FOUND |
| ERROR |
Set by ConnectionIF.execute() if HTTP Response equals:
500: INTERNAL_SERVER_ERROR
503: SERVICE_UNAVAILABLE
any other responses |
org.openptk.connection.jersey.JerseyConnection
| State |
Condition |
| NEW |
Default state from creation (Element) |
| READY |
Successful open method call |
| ERROR |
Failed open method call, could not get Client Information |
| DENIED |
HTTP 401 Unauthorized |
| NOTAUTHENTICATED |
Failed open method call.
Set by the close method |
Framework Tier
needs updating
Service Tier
JDBC
org.openptk.spi.operations.JdbcOperations
| State |
Method |
Object |
Condition |
| NEW |
constructor |
this |
Default state from creation (Element) |
| NULL |
getPtkResults() |
component |
Result Set is NULL |
| READY |
startup() |
this |
default State |
| SUCCESS |
doCreate() |
response |
Entry Created |
| |
doUpdate() |
response |
Entry Updated |
| |
doDelete() |
response |
Entry Deleted |
| |
doJdbcSelect() |
response |
READ: Entry Found |
| |
doJdbcSelect() |
response |
SEARCH: Nothing Found |
| |
doJdbcSelect() |
response |
SEARCH: Enries Found |
| AUTHENTICATED |
doAuthenticate() |
response |
Authenticated |
| ERROR |
startup() |
this |
Property is null |
| |
startup() |
this |
Value is null |
| |
startup() |
this |
ClassNotFoundException, Unable to load SQL Driver |
| |
shutdown() |
this |
SQLException, Unable to close SQL Connection |
| |
execute() |
this |
SQLException, Unable to create SQL Connection |
| |
getPtkResults() |
component |
SQLException |
| FAILED |
doCreate() |
response |
SQLException |
| |
doUpdate() |
response |
SQLException |
| |
doDelete() |
response |
SQLException |
| |
doAuthenticate() |
response |
err != null |
| |
doJdbcSelect() |
response |
SQLException, select failed |
| |
getPtkComponent() |
component |
Result Set and/or MetaData are NULL |
| NOTAUTHENTICATED |
doAuthenticate() |
response |
Not Authenticated: Invalid Credentials |
| NOTEXIST |
doJdbcSelect() |
response |
READ: Entry does not exist |
JNDI
org.openptk.spi.operations.JndiOperations
| State |
Method |
Object |
Condition |
| NEW |
constructor |
this |
Default state from creation (Element) |
| NULL |
getPtkComponent() |
component |
No entrydn found |
| |
getPtkComponent() |
component |
Attribute Enumeration is NULL |
| |
getPtkComponent() |
component |
The Entry is NULL |
| |
getPtkResults() |
component |
Results are NULL |
| READY |
startup() |
this |
default State |
| SUCCESS |
doCreate() |
response |
Entry Created |
| |
doRead() |
response |
Entry Found |
| |
doSearch() |
response |
Nothing was found |
| |
doSearch() |
response |
Entries Found |
| |
doUpdate() |
response |
Entry Updated |
| |
doDelete() |
response |
Entry Deleted |
| AUTHENTICATED |
doAuthenticate() |
response |
Authenticated |
| FAILED |
startup() |
this |
failed to start |
| |
doCreate() |
response |
NameAlreadyBoundException |
| |
doRead() |
response |
Invalid results, more than one entry was found |
| INVALID |
doCreate() |
response |
InvalidAttributesException |
| |
doCreate() |
response |
EntryDN is null |
| |
doRead() |
response |
Unique Search string is not found |
| |
doRead() |
response |
Unique Id attribute name is not set |
| |
doRead() |
response |
UniqueId value is not set |
| |
doUpdate() |
response |
AttributeModificationException |
| |
doUpdate() |
response |
EntryDN is NULL |
| |
doDelete() |
response |
EntryDN is NULL |
| |
doSearch() |
response |
Search value is not set |
| |
doAuthenticate() |
response |
attribute is empty |
| |
doAuthenticate() |
response |
attribute does not exist |
| |
doAuthenticate() |
response |
EntryDN is NULL |
| ERROR |
doCreate() |
response |
NamingException |
| |
doRead() |
response |
NamingException |
| |
doSearch() |
response |
NamingException |
| |
doUpdate() |
response |
NamingException |
| |
doDelete() |
response |
NotContextException |
| |
doDelete() |
response |
ContextNotEmptyException |
| |
doDelete() |
response |
NamingException |
| |
doAuthenticate() |
response |
The Property for the Password Attribute is null |
| |
getPtkComponent() |
component |
NamingException |
| |
getPtkComponent() |
component |
UniqueId has not be set |
| NOTEXIST |
doRead() |
response |
Entry does not exist |
| |
doUpdate() |
response |
NameNotFoundException |
| |
doDelete() |
response |
NameNotFoundException |
| NOTAUTHENTICATED |
doAuthenticate() |
response |
NamingException |
SPML
org.openptk.spi.operations.SpmlOperations
By default, the response's state is set to the requrest's state
| State |
Method |
Object |
Condition |
| NEW |
constructor |
this |
Default state from creation (Element) |
| SUCCESS |
postCreate() |
response |
Entry Created |
| |
postRead() |
response |
Entry Read |
| |
postUpdate() |
response |
Entry Updated |
| |
postDelete() |
response |
Entry Deleted |
| |
postSearch() |
response |
Entries found |
| |
postPwdChange() |
response |
Entry updated |
| |
postPwdReset() |
response |
Entry updated |
| READY |
getComponent() |
subject |
has attributes |
| ERROR |
startup() |
this |
SPML URL |
| |
doCreate() |
response |
SpmlException |
| |
doRead() |
response |
SpmlException |
| |
doUpdaate() |
response |
SpmlException |
| |
doDelete() |
response |
SpmlException |
| |
doSearch() |
response |
SpmlException |
| |
doPwdChange() |
response |
SpmlException |
| |
doPwdReset() |
response |
SpmlException |
| |
getComponent() |
subject |
no attributes |
| FAILED |
doSearch() |
response |
UNSUPPORTED_EXCEPTION |
| |
postCreate() |
response |
SPML Response is NULL, createResponse.isFailure() |
| |
postRead() |
response |
SPML Response is NULL, createResponse.isFailure() |
| |
postUpdate() |
response |
SPML Response is NULL, createResponse.isFailure() |
| |
postDelete() |
response |
SPML Response is NULL, createResponse.isFailure() |
| |
postSearch() |
response |
SPML Response is NULL, createResponse.isFailure() |
| |
postPwdChange() |
response |
SPML Response is NULL, createResponse.isFailure() |
| |
postPwdReset() |
response |
SPML Response is NULL, createResponse.isFailure() |
| INVALID |
preCreate() |
response |
Subject has no attributes |
| |
preRead() |
response |
Requires an Identifier, Request has a null Subject |
| |
preUpdate() |
response |
Requires an Identifier, Request has a null Subject, no attributes |
| |
preDelete() |
response |
Requires an Identifier, Request has a null Subject |
| |
prePwdChange() |
response |
Requires an Identifier, Request has a null Subject |
| |
prePwdReset() |
response |
Requires an Identifier, Request has a null Subject |
org.openptk.spi.operations.SpmlSunOperations
| State |
Method |
Object |
Condition |
| NEW |
constructor |
this |
Default state from creation (Element) |
| ERROR |
startup() |
this |
SPML URL |
| SUCCESS |
checkTimeoutCondition() |
response |
timeout |
org.openptk.spi.operations.SpeSpmlSunOperations
| State |
Method |
Object |
Condition |
| NEW |
constructor |
this |
Default state from creation (Element) |
| SUCCESS |
postPwdChange() |
response |
Entry updated |
| |
postPwdReset() |
response |
Entry updated |
SPML2
org.openptk.spi.operations.Spml2Operations
By default, the response's state is set to the requrest's state
| State |
Method |
Object |
Condition |
| NEW |
constructor |
this |
Default state from creation (Element) |
| SUCCESS |
postCreate() |
response |
Entry Created |
| |
postUpdate() |
response |
Entry Updated |
| |
postDelete() |
response |
Entry Deleted |
| |
postSearch() |
response |
Entries found |
| |
postPwdChange() |
response |
Entry updated |
| |
postPwdReset() |
response |
Entry updated |
| READY |
getComponent() |
subject |
has attributes |
| ERROR |
startup() |
this |
SPML URL |
| |
doCreate() |
response |
SpmlException |
| |
doRead() |
response |
SpmlException |
| |
doUpdaate() |
response |
SpmlException |
| |
doDelete() |
response |
SpmlException |
| |
doSearch() |
response |
SpmlException |
| |
doPwdChange() |
response |
SpmlException |
| |
doPwdReset() |
response |
SpmlException |
| |
preCreate() |
response |
Exception |
| |
getComponent() |
subject |
no attributes |
| |
getDsmlAttribute() |
this |
Exception |
| INVALID |
preCreate() |
response |
Subject has no attributes |
| |
preRead() |
response |
Requires an Identifier, Request has a null Subject |
| |
preUpdate() |
response |
Requires an Identifier, Request has a null Subject, no attributes |
| |
preDelete() |
response |
Requires an Identifier, Request has a null Subject |
| |
prePwdChange() |
response |
Requires an Identifier, Request has a null Subject |
| |
prePwdReset() |
response |
Requires an Identifier, Request has a null Subject |
| FAILED |
postCreate() |
response |
SPML Response is NULL, createResponse.isFailure() |
| |
postRead() |
response |
SPML Response is NULL, createResponse.isFailure() |
| |
postUpdate() |
response |
SPML Response is NULL, createResponse.isFailure() |
| |
postDelete() |
response |
SPML Response is NULL, createResponse.isFailure() |
| |
postSearch() |
response |
SPML Response is NULL, createResponse.isFailure() |
| |
postPwdChange() |
response |
SPML Response is NULL, createResponse.isFailure() |
| |
postPwdReset() |
response |
SPML Response is NULL, createResponse.isFailure() |
org.openptk.spi.operations.Spml2WavesetOperations
| State |
Method |
Object |
Condition |
| NEW |
constructor |
this |
Default state from creation (Element) |
| ERROR |
startup() |
this |
SPML URL |
| SUCCESS |
checkTimeoutCondition() |
response |
timeout |
org.openptk.spi.operations.Spml2OIMOperations
| State |
Method |
Object |
Condition |
| NEW |
constructor |
this |
Default state from creation (Element) |
| ERROR |
startup() |
this |
SPML URL |
|
|
