joynr.infrastructure.DacTypes

Class OwnerAccessControlEntry

java.lang.Object

joynr.infrastructure.DacTypes.ControlEntry

joynr.infrastructure.DacTypes.OwnerControlEntry

joynr.infrastructure.DacTypes.OwnerAccessControlEntry

All Implemented Interfaces:

JoynrType, Serializable

public class OwnerAccessControlEntry
extends OwnerControlEntry
implements Serializable, JoynrType

The Owner Access Control Entry (Owner ACE) stores consumer permissions of users for a domain/interface/operation combination. Owner ACEs are stored by the Owner Access Control List (Owner ACL). If UID, domain, interface and operation values of an Owner ACE match the values of an Master ACE, default consumer permissions and TLs of the Master ACE get overwritten by the consumer permissions and TLs of the Owner ACE unless the consumer permissions or TLs conflict with their respective possible consumer permissions and TLs.

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
OwnerAccessControlEntry() Default Constructor
OwnerAccessControlEntry(OwnerAccessControlEntry ownerAccessControlEntryObj) Copy constructor
OwnerAccessControlEntry(String uid, String domain, String interfaceName, TrustLevel requiredTrustLevel, TrustLevel requiredAceChangeTrustLevel, String operation, Permission consumerPermission) Parameterized constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Check for equality
Permission	getConsumerPermission() Gets ConsumerPermission
String	getOperation() Gets Operation
int	hashCode() Calculate code for hashing based on member contents
void	setConsumerPermission(Permission consumerPermission) Sets ConsumerPermission
void	setOperation(String operation) Sets Operation
String	toString() Stringifies the class

Methods inherited from class joynr.infrastructure.DacTypes.OwnerControlEntry

getRequiredAceChangeTrustLevel, getRequiredTrustLevel, setRequiredAceChangeTrustLevel, setRequiredTrustLevel

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

OwnerAccessControlEntry

public OwnerAccessControlEntry()

Default Constructor

OwnerAccessControlEntry

public OwnerAccessControlEntry(OwnerAccessControlEntry ownerAccessControlEntryObj)

Copy constructor

Parameters:

ownerAccessControlEntryObj - reference to the object to be copied

OwnerAccessControlEntry

public OwnerAccessControlEntry(String uid,
                               String domain,
                               String interfaceName,
                               TrustLevel requiredTrustLevel,
                               TrustLevel requiredAceChangeTrustLevel,
                               String operation,
                               Permission consumerPermission)

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.

requiredTrustLevel - The Trust Level (TL) that is needed by the requester in order to get the permission defined in this CE. The TL must be listed in the possible required TLs of the corresponding Master CE. Otherwise this constitutes a conflict.

requiredAceChangeTrustLevel - The Trust Level (TL) that is needed by the requester in order to create, edit or delete an Owner ACE. The TL must be listed in the possible required CE Change TLs of the corresponding Master CE. Otherwise this constitutes a conflict.

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).

consumerPermission - The consumer permission that applies to the specified domain/interface/operation combination. The permission must be listed in possible consumer permissions of the corresponding Master ACE. Otherwise this constitutes a conflict.

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).

getConsumerPermission

public Permission getConsumerPermission()

Gets ConsumerPermission

Returns:

The consumer permission that applies to the specified domain/interface/operation combination. The permission must be listed in possible consumer permissions of the corresponding Master ACE. Otherwise this constitutes a conflict.

setConsumerPermission

public void setConsumerPermission(Permission consumerPermission)

Sets ConsumerPermission

Parameters:

consumerPermission - The consumer permission that applies to the specified domain/interface/operation combination. The permission must be listed in possible consumer permissions of the corresponding Master ACE. Otherwise this constitutes a conflict.

toString

public String toString()

Stringifies the class

Overrides:

toString in class OwnerControlEntry

Returns:

stringified class content

equals

public boolean equals(Object obj)

Check for equality

Overrides:

equals in class OwnerControlEntry

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 OwnerControlEntry

Returns:

The calculated hash code