joynr.infrastructure.DacTypes

Class MasterControlEntry

java.lang.Object

joynr.infrastructure.DacTypes.ControlEntry

joynr.infrastructure.DacTypes.MasterControlEntry

All Implemented Interfaces:

JoynrType, Serializable

Direct Known Subclasses:

MasterAccessControlEntry, MasterRegistrationControlEntry

public class MasterControlEntry
extends ControlEntry
implements Serializable, JoynrType

The Master Control Entry (Master CE) stores default Trust Levels (TLs) of users that must be met to apply this CE or to change this CE. Additionally, it contains possible TLs to be used to override default TLs in Owner Control Entries (Owner CEs). It is the base class for MasterAccessControlEntry and MasterRegistrationControlEntry.

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
MasterControlEntry() Default Constructor
MasterControlEntry(MasterControlEntry masterControlEntryObj) Copy constructor
MasterControlEntry(String uid, String domain, String interfaceName, TrustLevel defaultRequiredTrustLevel, TrustLevel[] possibleRequiredTrustLevels, TrustLevel defaultRequiredControlEntryChangeTrustLevel, TrustLevel[] possibleRequiredControlEntryChangeTrustLevels) Parameterized constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Check for equality
TrustLevel	getDefaultRequiredControlEntryChangeTrustLevel() Gets DefaultRequiredControlEntryChangeTrustLevel
TrustLevel	getDefaultRequiredTrustLevel() Gets DefaultRequiredTrustLevel
TrustLevel[]	getPossibleRequiredControlEntryChangeTrustLevels() Gets PossibleRequiredControlEntryChangeTrustLevels
TrustLevel[]	getPossibleRequiredTrustLevels() Gets PossibleRequiredTrustLevels
int	hashCode() Calculate code for hashing based on member contents
void	setDefaultRequiredControlEntryChangeTrustLevel(TrustLevel defaultRequiredControlEntryChangeTrustLevel) Sets DefaultRequiredControlEntryChangeTrustLevel
void	setDefaultRequiredTrustLevel(TrustLevel defaultRequiredTrustLevel) Sets DefaultRequiredTrustLevel
void	setPossibleRequiredControlEntryChangeTrustLevels(TrustLevel[] possibleRequiredControlEntryChangeTrustLevels) Sets PossibleRequiredControlEntryChangeTrustLevels
void	setPossibleRequiredTrustLevels(TrustLevel[] possibleRequiredTrustLevels) Sets PossibleRequiredTrustLevels
String	toString() Stringifies the class

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

MasterControlEntry

public MasterControlEntry()

Default Constructor

MasterControlEntry

public MasterControlEntry(MasterControlEntry masterControlEntryObj)

Copy constructor

Parameters:

masterControlEntryObj - reference to the object to be copied

MasterControlEntry

public MasterControlEntry(String uid,
                          String domain,
                          String interfaceName,
                          TrustLevel defaultRequiredTrustLevel,
                          TrustLevel[] possibleRequiredTrustLevels,
                          TrustLevel defaultRequiredControlEntryChangeTrustLevel,
                          TrustLevel[] possibleRequiredControlEntryChangeTrustLevels)

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.

Method Detail

getDefaultRequiredTrustLevel

public TrustLevel getDefaultRequiredTrustLevel()

Gets DefaultRequiredTrustLevel

Returns:

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

setDefaultRequiredTrustLevel

public void setDefaultRequiredTrustLevel(TrustLevel defaultRequiredTrustLevel)

Sets DefaultRequiredTrustLevel

Parameters:

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

getPossibleRequiredTrustLevels

public TrustLevel[] getPossibleRequiredTrustLevels()

Gets PossibleRequiredTrustLevels

Returns:

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

setPossibleRequiredTrustLevels

public void setPossibleRequiredTrustLevels(TrustLevel[] possibleRequiredTrustLevels)

Sets PossibleRequiredTrustLevels

Parameters:

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

getDefaultRequiredControlEntryChangeTrustLevel

public TrustLevel getDefaultRequiredControlEntryChangeTrustLevel()

Gets DefaultRequiredControlEntryChangeTrustLevel

Returns:

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

setDefaultRequiredControlEntryChangeTrustLevel

public void setDefaultRequiredControlEntryChangeTrustLevel(TrustLevel defaultRequiredControlEntryChangeTrustLevel)

Sets DefaultRequiredControlEntryChangeTrustLevel

Parameters:

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

getPossibleRequiredControlEntryChangeTrustLevels

public TrustLevel[] getPossibleRequiredControlEntryChangeTrustLevels()

Gets PossibleRequiredControlEntryChangeTrustLevels

Returns:

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

setPossibleRequiredControlEntryChangeTrustLevels

public void setPossibleRequiredControlEntryChangeTrustLevels(TrustLevel[] possibleRequiredControlEntryChangeTrustLevels)

Sets PossibleRequiredControlEntryChangeTrustLevels

Parameters:

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.

toString

public String toString()

Stringifies the class

Overrides:

toString in class ControlEntry

Returns:

stringified class content

equals

public boolean equals(Object obj)

Check for equality

Overrides:

equals in class ControlEntry

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 ControlEntry

Returns:

The calculated hash code