Package com.caplin.permissioning
The Caplin Permissioning Integration API provides classes and interfaces that allow you to create Permissioning Adapters.
A Permissioning Adapter sends permissioning data to Caplin Liberator. The source of the permissioning data may be a permission system that is not part of Caplin Platform, but which you want to integrate with Caplin Trader.
The Permissioning Integration API uses the services of the Caplin DataSource
for Java API (package com.caplin.datasource
and its subpackages),
allowing the Adapter to send permissioning data to Liberator
using the DataSource protocol, but without the need to write code at the
DataSource API level.
For additional information about how to use this API, see the following resources:
-
Interface Summary Interface Description GlobalContext A customSubjectMapper
can call one of theget()
methods of this interface to access data that is common all subject mappers.SpecialFieldProvider SubjectMapper The SubjectMapper interface must be implemented by any customSubjectMapper
class that you write.SwitchableSubjectMapper Deprecated. This interface exists purely to support a mode of TOBO that is inferior in many ways to the other supported TOBO modes.UserRequestListener -
Class Summary Class Description Constants Constants used when interacting with the the Permissioning APIDefaultGlobalContext This class implements theGlobalContext
interface and is already deployed at the Permissioning Auth Module.Group A grouping of users and/or other groups.Permissionable Classes that extend this class can be assigned permissions.PermissioningDataSource When aPermissioningDataSource
is constructed it must be supplied with aDataSource
object.PermissionPublisher RegexSuffixSubjectMapper This implementation of theSubjectMapper
interface maps subjects in the same manner as the defaultSubjectMapper
(see the section on Mapping Logic, below), but unlike the defaultSubjectMapper
it permits multiple mappings to be added to it.SubjectMapping A convenience class that can be used by implementations ofSubjectMapper
to store the keys and subject mappings passed to itsupdateMappings
method.SwitchByKeySubjectPatternMapper Deprecated. See the deprecation warning inSwitchableSubjectMapper
.User Represents a permissioned user that is able to log on to Caplin Trader. -
Enum Summary Enum Description Authorization Defines the allowed types of authorization that can be applied to an action.Role Defines the possible roles for aPermissioningDataSource
-
Exception Summary Exception Description ActionAlreadyExistsException Thrown at runtime if one attempts to create aRule
that specifies anaction
which has already been specified by another, earlier createdRule
.DuplicateNodeException Thrown when adding aPermissionable
to a group, when thatPermissionable
already exists as a member.InvalidHierarchyException Thrown if the hierarchy to be created is unacceptable.NoTransactionInProgressException Thrown when an attempted operation requires a transaction to be in progress; however one is not.TransactionInProgressException Thrown when an attempt is made to start a new transaction if another transaction is still in progress.