com.smartdevicelink.managers.permission

Class PermissionManager

java.lang.Object

com.smartdevicelink.managers.BaseSubManager

com.smartdevicelink.managers.permission.PermissionManager

public class PermissionManager
extends BaseSubManager

PermissionManager gives the developer information about what permissions are permitted in specific HMI level and helps developers setup listeners to be called when specific permissions become allowed.

This should be used through the SdlManager and not be instantiated by itself

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	com.smartdevicelink.managers.permission.BasePermissionManager.PermissionGroupStatus
static interface	com.smartdevicelink.managers.permission.BasePermissionManager.PermissionGroupType

Field Summary

Fields

Modifier and Type	Field and Description
static int	PERMISSION_GROUP_STATUS_ALLOWED
static int	PERMISSION_GROUP_STATUS_DISALLOWED
static int	PERMISSION_GROUP_STATUS_MIXED
static int	PERMISSION_GROUP_STATUS_UNKNOWN
static int	PERMISSION_GROUP_TYPE_ALL_ALLOWED
static int	PERMISSION_GROUP_TYPE_ANY

Fields inherited from class com.smartdevicelink.managers.BaseSubManager

ERROR, internalInterface, LIMITED, READY, SETTING_UP, SHUTDOWN

Constructor Summary

Constructors

Constructor and Description
PermissionManager(ISdl internalInterface) Creates a new instance of the PermissionManager

Method Summary

Modifier and Type	Method and Description
UUID	addListener(List<PermissionElement> permissionElements, int groupType, OnPermissionChangeListener listener) Add a listener to be called when there is permissions change.
void	dispose() Clean up everything after the manager is no longer needed
int	getGroupStatusOfPermissions(List<PermissionElement> permissionElements) Determine if a group of permissions is allowed for the current HMI level
boolean	getRequiresEncryption() Gets the encryption requirement
boolean	getRPCRequiresEncryption(FunctionID rpcName) Checks if an RPC requires encryption
Map<FunctionID,PermissionStatus>	getStatusOfPermissions(List<PermissionElement> permissionElements) Determine if a group of permissions is allowed for the current HMI level This method is similar to getGroupStatusOfPermissions() but returns more detailed result about each individual permission
boolean	isPermissionParameterAllowed(FunctionID rpcName, String parameter) Determine if an individual permission parameter is allowed for current permission items and current HMI level
boolean	isRPCAllowed(FunctionID rpcName) Determine if an individual RPC is allowed for the current permission items and HMI level
void	removeListener(UUID listenerId) Removes specific listener
void	start(CompletionListener listener) Starts up a BaseSubManager, and calls provided callback once BaseSubManager is done setting up or failed setup.

Methods inherited from class com.smartdevicelink.managers.BaseSubManager

getState, handleTransportUpdated, onTransportUpdate, transitionToState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PERMISSION_GROUP_STATUS_ALLOWED

public static final int PERMISSION_GROUP_STATUS_ALLOWED

See Also:

Constant Field Values

PERMISSION_GROUP_STATUS_DISALLOWED

public static final int PERMISSION_GROUP_STATUS_DISALLOWED

See Also:

Constant Field Values

PERMISSION_GROUP_STATUS_MIXED

public static final int PERMISSION_GROUP_STATUS_MIXED

See Also:

Constant Field Values

PERMISSION_GROUP_STATUS_UNKNOWN

public static final int PERMISSION_GROUP_STATUS_UNKNOWN

See Also:

Constant Field Values

PERMISSION_GROUP_TYPE_ALL_ALLOWED

public static final int PERMISSION_GROUP_TYPE_ALL_ALLOWED

See Also:

Constant Field Values

PERMISSION_GROUP_TYPE_ANY

public static final int PERMISSION_GROUP_TYPE_ANY

See Also:

Constant Field Values

Constructor Detail

PermissionManager

public PermissionManager(@NonNull
                         ISdl internalInterface)

Creates a new instance of the PermissionManager

Parameters:

internalInterface -

Method Detail

start

public void start(CompletionListener listener)

Description copied from class: BaseSubManager

Starts up a BaseSubManager, and calls provided callback once BaseSubManager is done setting up or failed setup.

Overrides:

start in class BaseSubManager

Parameters:

listener - CompletionListener that is called once the BaseSubManager's state is READY, LIMITED, or ERROR

getRPCRequiresEncryption

public boolean getRPCRequiresEncryption(@NonNull
                                        FunctionID rpcName)

Checks if an RPC requires encryption

Parameters:

rpcName - the rpc name (FunctionID) to check

Returns:

true if the given RPC requires encryption; false, otherwise

getRequiresEncryption

public boolean getRequiresEncryption()

Gets the encryption requirement

Returns:

true if encryption is required; false otherwise

isRPCAllowed

public boolean isRPCAllowed(@NonNull
                            FunctionID rpcName)

Determine if an individual RPC is allowed for the current permission items and HMI level

Parameters:

rpcName - rpcName FunctionID value that represents the name of the RPC

Returns:

boolean represents whether the RPC is allowed or not

isPermissionParameterAllowed

public boolean isPermissionParameterAllowed(@NonNull
                                            FunctionID rpcName,
                                            @NonNull
                                            String parameter)

Determine if an individual permission parameter is allowed for current permission items and current HMI level

Parameters:

rpcName - FunctionID value that represents the name of the RPC

parameter - String value that represents a parameter for the RPC

Returns:

boolean represents whether the permission parameter is allowed or not

dispose

public void dispose()

Clean up everything after the manager is no longer needed

Overrides:

dispose in class BaseSubManager

getGroupStatusOfPermissions

public int getGroupStatusOfPermissions(@NonNull
                                       List<PermissionElement> permissionElements)

Determine if a group of permissions is allowed for the current HMI level

Parameters:

permissionElements - list of PermissionElement that represents the RPC names and their parameters

Returns:

PermissionGroupStatus int value that gives an overall view whether the permissions are allowed or not

See Also:

BasePermissionManager.PermissionGroupStatus

getStatusOfPermissions

public Map<FunctionID,PermissionStatus> getStatusOfPermissions(@NonNull
                                                               List<PermissionElement> permissionElements)

Determine if a group of permissions is allowed for the current HMI level This method is similar to getGroupStatusOfPermissions() but returns more detailed result about each individual permission

Parameters:

permissionElements - list of PermissionElement that represents the RPC names and their parameters

Returns:

a map with keys that are the passed in RPC names specifying if that RPC and its parameter permissions are currently allowed for the current HMI level

addListener

public UUID addListener(@NonNull
                        List<PermissionElement> permissionElements,
                        int groupType,
                        @NonNull
                        OnPermissionChangeListener listener)

Add a listener to be called when there is permissions change. When the listener is added it will be called immediately with the current permission values if the values comply with with the passed groupType

Parameters:

permissionElements - list of PermissionElement that represents the RPC names and their parameters

groupType - PermissionGroupType int value represents whether we need the listener to be called when there is any permissions change or only when all permission become allowed

listener - OnPermissionChangeListener interface

Returns:

unique uuid number for the listener. It can be used to remove the listener later.

removeListener

public void removeListener(@NonNull
                           UUID listenerId)

Removes specific listener

Parameters:

listenerId - the id of the listener