joynr.infrastructure.DacTypes

Class MasterAccessControlEntry

java.lang.Object

joynr.infrastructure.DacTypes.ControlEntry

joynr.infrastructure.DacTypes.MasterControlEntry

joynr.infrastructure.DacTypes.MasterAccessControlEntry

All Implemented Interfaces:

JoynrType, Serializable

public class MasterAccessControlEntry
extends MasterControlEntry
implements Serializable, JoynrType

The Master Access Control Entry (Master ACE) stores default consumer permissions of users for a domain/interface/operations combination. Additionally, it contains possible consumer permissions to be used to override default consumer permissions in Owner Access Control Entries (Owner ACEs). Master ACEs are stored by the Master Access Control List (Master ACL) and the optional Mediator Access Control List (Mediator ACL).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAJOR_VERSION
static int	MINOR_VERSION

Constructor Summary

Constructors

Constructor and Description
MasterAccessControlEntry() Default Constructor
MasterAccessControlEntry(MasterAccessControlEntry masterAccessControlEntryObj) Copy constructor
MasterAccessControlEntry(String uid, String domain, String interfaceName, TrustLevel defaultRequiredTrustLevel, TrustLevel[] possibleRequiredTrustLevels, TrustLevel defaultRequiredControlEntryChangeTrustLevel, TrustLevel[] possibleRequiredControlEntryChangeTrustLevels, String operation, Permission defaultConsumerPermission, Permission[] possibleConsumerPermissions) Parameterized constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Check for equality
Permission	getDefaultConsumerPermission() Gets DefaultConsumerPermission
String	getOperation() Gets Operation
Permission[]	getPossibleConsumerPermissions() Gets PossibleConsumerPermissions
int	hashCode() Calculate code for hashing based on member contents
void	setDefaultConsumerPermission(Permission defaultConsumerPermission) Sets DefaultConsumerPermission
void	setOperation(String operation) Sets Operation
void	setPossibleConsumerPermissions(Permission[] possibleConsumerPermissions) Sets PossibleConsumerPermissions
String	toString() Stringifies the class

Methods inherited from class joynr.infrastructure.DacTypes.MasterControlEntry

getDefaultRequiredControlEntryChangeTrustLevel, getDefaultRequiredTrustLevel, getPossibleRequiredControlEntryChangeTrustLevels, getPossibleRequiredTrustLevels, setDefaultRequiredControlEntryChangeTrustLevel, setDefaultRequiredTrustLevel, setPossibleRequiredControlEntryChangeTrustLevels, setPossibleRequiredTrustLevels

Methods inherited from class joynr.infrastructure.DacTypes.ControlEntry

getDomain, getInterfaceName, getUid, setDomain, setInterfaceName, setUid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAJOR_VERSION

public static final int MAJOR_VERSION

See Also:

Constant Field Values

MINOR_VERSION

public static final int MINOR_VERSION

See Also:

Constant Field Values

Constructor Detail

MasterAccessControlEntry

public MasterAccessControlEntry()

Default Constructor

MasterAccessControlEntry

public MasterAccessControlEntry(MasterAccessControlEntry masterAccessControlEntryObj)

Copy constructor

Parameters:

masterAccessControlEntryObj - reference to the object to be copied

MasterAccessControlEntry

public MasterAccessControlEntry(String uid,
                                String domain,
                                String interfaceName,
                                TrustLevel defaultRequiredTrustLevel,
                                TrustLevel[] possibleRequiredTrustLevels,
                                TrustLevel defaultRequiredControlEntryChangeTrustLevel,
                                TrustLevel[] possibleRequiredControlEntryChangeTrustLevels,
                                String operation,
                                Permission defaultConsumerPermission,
                                Permission[] possibleConsumerPermissions)

Parameterized constructor

Parameters:

uid - A unique user ID (UID) this Control Entry (CE) applies to or the wildcard character (asterisk sign) if this CE applies to all users. CEs that use the wildcard character are overruled by specific ones (if they exist).

domain - The domain this Control Entry (CE) applies to.

interfaceName - The interface this Control Entry (CE) applies to.

defaultRequiredTrustLevel - The default required trusted level (TL). TL depends on used device and Authentication mechanism.

possibleRequiredTrustLevels - A list of all possible Trust Levels that may be used in an owner CE to overwrite the default required TL.

defaultRequiredControlEntryChangeTrustLevel - The default Trust Level (TL) that is needed by the requester in order to create, edit or delete a corresponding owner CE.

possibleRequiredControlEntryChangeTrustLevels - A list of all possible Trust Levels (TLs) that may be used in an owner CE to override the default required CE change TL.

operation - The operation this Access Control Entry (ACE) applies to or the wildcard character (asterisk sign) if this ACE applies to all operations of the corresponding interface. ACEs that use the wildcard character are overruled by specific ones (if they exist).

defaultConsumerPermission - The default consumer permission that applies to the specified domain, interface and operations combination if there does not exist a corresponding ACE in the owner Access Control List (ACL).

possibleConsumerPermissions - A list of all possible consumer permissions that may be used in an owner ACE to overwrite the default consumer permission.

Method Detail

getOperation

public String getOperation()

Gets Operation

Returns:

The operation this Access Control Entry (ACE) applies to or the wildcard character (asterisk sign) if this ACE applies to all operations of the corresponding interface. ACEs that use the wildcard character are overruled by specific ones (if they exist).

setOperation

public void setOperation(String operation)

Sets Operation

Parameters:

operation - The operation this Access Control Entry (ACE) applies to or the wildcard character (asterisk sign) if this ACE applies to all operations of the corresponding interface. ACEs that use the wildcard character are overruled by specific ones (if they exist).

getDefaultConsumerPermission

public Permission getDefaultConsumerPermission()

Gets DefaultConsumerPermission

Returns:

The default consumer permission that applies to the specified domain, interface and operations combination if there does not exist a corresponding ACE in the owner Access Control List (ACL).

setDefaultConsumerPermission

public void setDefaultConsumerPermission(Permission defaultConsumerPermission)

Sets DefaultConsumerPermission

Parameters:

defaultConsumerPermission - The default consumer permission that applies to the specified domain, interface and operations combination if there does not exist a corresponding ACE in the owner Access Control List (ACL).

getPossibleConsumerPermissions

public Permission[] getPossibleConsumerPermissions()

Gets PossibleConsumerPermissions

Returns:

A list of all possible consumer permissions that may be used in an owner ACE to overwrite the default consumer permission.

setPossibleConsumerPermissions

public void setPossibleConsumerPermissions(Permission[] possibleConsumerPermissions)

Sets PossibleConsumerPermissions

Parameters:

possibleConsumerPermissions - A list of all possible consumer permissions that may be used in an owner ACE to overwrite the default consumer permission.

toString

public String toString()

Stringifies the class

Overrides:

toString in class MasterControlEntry

Returns:

stringified class content

equals

public boolean equals(Object obj)

Check for equality

Overrides:

equals in class MasterControlEntry

Parameters:

obj - Reference to the object to compare to

Returns:

true, if objects are equal, false otherwise

hashCode

public int hashCode()

Calculate code for hashing based on member contents

Overrides:

hashCode in class MasterControlEntry

Returns:

The calculated hash code