An implementation of the IPermission interface. You should create instances
of this class if you want to use the KeyMaster permissioning system.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class Permission : IPermission
Public Class Permission _ Implements IPermission
public ref class Permission : IPermission
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | Permission(String) |
Initializes a new instance of the Permission class with a subject pattern.
The initial permission settings deny all access to the subjects that match the subject pattern.
|
| Permission(String, Boolean, Boolean, Boolean) |
Initializes a new instance of the Permission class with permissions for a subject pattern.
|
| Permission(String, Boolean, Boolean, Boolean, String) |
Initializes a new instance of the Permission class with permissions for a subject pattern,
and the name of a field specifying an instrument that can be traded.
|
| Equals(Object) | (Inherited from Object.) |
 | Finalize()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| GetHashCode()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
 | InstrumentField |
Gets or sets the instrument field.
|
| MemberwiseClone()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| ReadAllowed |
Gets or sets a value indicating whether the user can read subjects matching SubjectPattern.
|
| SubjectPattern |
Gets or sets a regular expression representing the subjects that should have the permissions
defined by this instance of Permission.
|
| ToString()()() |
Returns a String that represents this instance.
(Overrides Object.ToString()()().) |
| TradeAllowed |
Gets or sets a value indicating whether the user can trade on subjects matching SubjectPattern.
|
| WriteAllowed |
Gets or sets a value indicating whether the user can contribute to (publish to)
subjects matching SubjectPattern.
|
RemarksThe permissioning system can control read and write access to subjects selected by the specified SubjectPattern.
Within the Caplin Xaqua environment there is a dedicated trade channel (subject) per asset class, for each user. If the trade channel subject is within the ^/TRADE/FX namespace and you wish to permit trading for the user on subjects within the ^/FX/ namespace, then the permissions should be configured as follows:
| SubjectPattern | ReadAllowed | WriteAllowed | TradeAllowed | InstrumentField |
| ^/TRADE/FX | true | true | false | InstrumentField |
| ^/FX | true | false | true | null |
Inheritance Hierarchy| Object | |
 | Permission |