Package org.forgerock.openam.sts.soap
The classes in this package provide context to help set the various configuration options in the CXF STS client
necessary to consume sts instances published via OpenAM. They are intended as examples to help guide the development
of sts clients.
Note that the classes in this module augment those in the openam-client-sts module. The classes in the openam-client-sts
module are included in the OpenAM client SDK. The classes in the current module cannot be placed in the openam-client-sts
module, as that would pollute the OpenAM .war file with cxf-related dependencies. Likewise, the soap-sts-related
classes in the openam-client-sts module cannot be placed in this current module, as they are needed by e.g. the
openam-publish-sts module, and the openam-rest-sts module (some domain objects, like SAML2Config, are shared between
the soap and rest sts), and thus would have to be referenced by these modules, which would again pollute the OpenAM
.war file with cxf-related dependencies. The bottom line is that the openam-soap-sts module is largely stand-alone -
the .war file in the openam-soap-sts-server is deployed distinct from the OpenAM .war file, and the classes in the
openam-soap-sts-client module are stand-alone examples helpful in configuring the cxf-sts-client to successfully consume
published soap-sts instances. Thus the cxf-dependencies in the openam-soap-sts sub-modules won't pollute the OpenAM
.war file, and the openam-soap-sts can deploy any cxf version without fear of side-effects. This does mean, however,
that clients who wish to programmatically publish soap-sts instances, and then consume these instances, must
have both the OpenAM client-sdk, and the .jar file produced by the openam-soap-sts-client module, in their classpath
(in addition to the cxf-related dependencies defined in the openam-soap-sts-client pom file).
-
Class Summary Class Description EndpointSpecification Encapsulates the service and port specification of a single sts instance, with a convenience method (getStandardEndpointSpecification) to target the standard set of sts instances published by OpenAM.OpenAMSessionTokenCallback Callback class used to solicit and obtain the OpenAM session id from the OpenAMSessionTokenClientAssertionBuilder.SoapSTSCallbackHandler An instance of this class is set in the StaticSTSProperties passed to the cxf-runtime.SoapSTSConsumer This class wraps the org.apache.cxf.ws.security.trust.STSClient to provide configuration state necessary to consume published soap-sts instances.SoapSTSConsumer.SoapSTSConsumerBuilder SoapSTSConsumerCallbackHandler The CallbackHandler which supports all of the possible Callback types required by the SoapSTSConsumer.SoapSTSConsumerCallbackHandler.SoapSTSConsumerCallbackHandlerBuilder STSBroker This class is the endpoint specified in web.xml as the recipient for all SOAP invocations targeting STS instances.STSEndpoint An instance of this class is created for each STS instance.TokenSpecification This class provides means to create TokenSpecification instances which encapsulate the state necessary to issue tokens of various types, currently limited to SAML2 Bearer, HolderOfKey, and SenderVouches assertions. -
Exception Summary Exception Description SoapSTSConsumerException Exception thrown by the SoapSTSConsumer