public abstract class SecurityContext extends Object implements WorkContext
WorkContextthat allows a
Workinstance to propagate security related context information from an EIS to an application server.
This allows an EIS/resource adapter to flow-in security context information and execute a Work instance, and call methods on a MessageEndpoint interface, to effect message inflow, within that Work instance, in the context of an established identity.
A resource adapter indicates to the WorkManager, that a Work instance needs to be run in a specified security execution context by submitting a Work instance that implements WorkContextProvider interface and ensuring that the List of WorkContexts for that Work instance contains an instance of its subclass of SecurityContext.
It should be noted however that when a resource adapter flows-in an identity to be used by the application server, the propagated identity may or may not belong to the application server's security domain.
There are therefore, two scenarios while a resource adapter propagates a security identity from an EIS to the application server:
|Constructor and Description|
|Modifier and Type||Method and Description|
Get the brief description of the role played by the
Get the associated name of the
The container calls this method to set up the security Context for the
public String getDescription()
WorkContextand any other related debugging information. This could be used by the WorkManager and the resource adapter for debugging purposes.
public String getName()
WorkContext. This could be used by the WorkManager and the resource adapter for debugging purposes.
public abstract void setupSecurityContext(CallbackHandler handler, Subject executionSubject, Subject serviceSubject)
The handler argument must not be null, and the argument handler and the
CallbackHandler passed to this method must support the
Callbacks defined in the Jakarta Authentication
Callbacks may be supported by the container.
CallerPrincipalCallback"to set the container's representation of the caller principal. The CallbackHandler must establish the argument Principal as the caller principal associated with the invocation being processed by the container. When the argument Principal is null, the handler will establish the container's representation of the unauthenticated caller principal."
A resource adapter might use the
establish the container's representation of the corresponding group
principals within the Subject. When a null value is passed to the groups
argument, the handler will establish the container's representation of no
group principals within the Subject. Otherwise, the handler's processing
of this callback is additive, yielding the union (without duplicates) of
the principals existing within the Subject, and those created with the
names occurring within the argument array. The CallbackHandler will
define the type of the created principals."
A resource adapter might use the
"to employ the password validation facilities of its containing runtime."
The executionSubject argument must be non-null and it must not be read-only. It is expected that this method will populate this executionSubject with principals and credentials that would be flown into the application server.
The serviceSubject argument may be null, and when it is not null it must not be read-only. It represents the application server and it may be used by the Work implementation to retrieve Principals and credentials necessary to establish a connection to the EIS (in the cause of mutual-auth like scenarios). If the Subject is not null, the Work implementation may collect the server credentials, as necessary, by using the callback handler passed to them .
When this method is called, the method implementation
See Jakarta Authentication specification and related JavaDoc
CallbackHandlerprovided by the
WorkManagerthat supports the
Callbacks described above
executionSubject- A Subject that represents the security identity that needs to be established as the context for the
Workinstance. It is used by the method implementation to store Principals and credentials that needs to be used as the security context of the
serviceSubject- A Subject that represents the application server It may be used by the method implementation as the source of Principals or credentials to be used to validate a connection to the EIS. If the Subject is not null, the method implementation may add additional Principals or credentials (pertaining to the recipient of the service request) to the Subject. *
Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.