org.eclipse.dirigible.core.security.api

Interface ISecurityCoreService

All Superinterfaces:

ICoreService

All Known Implementing Classes:

SecurityCoreService

public interface ISecurityCoreService
extends ICoreService

The Security Core Service interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_EXTENSION_ACCESS
static String	FILE_EXTENSION_ROLES

Method Summary

Modifier and Type	Method and Description
AccessDefinition	createAccessDefinition(String location, String uri, String method, String role, String description) Creates the access definition.
RoleDefinition	createRole(String name, String location, String description) Creates the role.
boolean	existsAccessDefinition(String uri, String method, String role) Exists access definition.
boolean	existsRole(String name) Exists role.
AccessDefinition	getAccessDefinition(long id) Gets the access definition.
AccessDefinition	getAccessDefinition(String uri, String method, String role) Gets the access definition.
List<AccessDefinition>	getAccessDefinitions() Gets the access definitions.
List<AccessDefinition>	getAccessDefinitionsByUri(String uri) Gets the access definitions by uri.
List<AccessDefinition>	getAccessDefinitionsByUriAndMethod(String uri, String method) Gets the access definitions by uri and method.
RoleDefinition	getRole(String name) Gets the role.
List<RoleDefinition>	getRoles() Gets the roles.
boolean	isAccessAllowed(String uri, String method, String role) Checks if is access allowed.
List<AccessDefinition>	parseAccessDefinitions(byte[] json) Parses the access definitions.
List<AccessDefinition>	parseAccessDefinitions(String json) Parses the access definitions.
RoleDefinition[]	parseRoles(byte[] json) Parses the roles.
RoleDefinition[]	parseRoles(String json) Parses the roles.
void	removeAccessDefinition(long id) Removes the access definition.
void	removeRole(String name) Removes the role.
String	serializeAccessDefinitions(List<AccessDefinition> accessDefinitions) Serialize access definitions.
String	serializeRoles(RoleDefinition[] roles) Serialize roles.
void	updateAccessDefinition(long id, String location, String uri, String method, String role, String description) Update access definition.
void	updateRole(String name, String location, String description) Update role.

Field Detail

FILE_EXTENSION_ACCESS

static final String FILE_EXTENSION_ACCESS

See Also:

Constant Field Values

FILE_EXTENSION_ROLES

static final String FILE_EXTENSION_ROLES

See Also:

Constant Field Values

Method Detail

createRole

RoleDefinition createRole(String name,
                          String location,
                          String description)
                   throws AccessException

Creates the role.

Parameters:

name - the name

location - the location

description - the description

Returns:

the role definition

Throws:

AccessException - the access exception

getRole

RoleDefinition getRole(String name)
                throws AccessException

Gets the role.

Parameters:

name - the name

Returns:

the role

Throws:

AccessException - the access exception

existsRole

boolean existsRole(String name)
            throws AccessException

Exists role.

Parameters:

name - the name

Returns:

true, if successful

Throws:

AccessException - the access exception

removeRole

void removeRole(String name)
         throws AccessException

Removes the role.

Parameters:

name - the name

Throws:

AccessException - the access exception

updateRole

void updateRole(String name,
                String location,
                String description)
         throws AccessException

Update role.

Parameters:

name - the name

location - the location

description - the description

Throws:

AccessException - the access exception

getRoles

List<RoleDefinition> getRoles()
                       throws AccessException

Gets the roles.

Returns:

the roles

Throws:

AccessException - the access exception

createAccessDefinition

AccessDefinition createAccessDefinition(String location,
                                        String uri,
                                        String method,
                                        String role,
                                        String description)
                                 throws AccessException

Creates the access definition.

Parameters:

location - the location

uri - the uri

method - the method

role - the role

description - the description

Returns:

the access definition

Throws:

AccessException - the access exception

getAccessDefinition

AccessDefinition getAccessDefinition(long id)
                              throws AccessException

Gets the access definition.

Parameters:

id - the id

Returns:

the access definition

Throws:

AccessException - the access exception

getAccessDefinition

AccessDefinition getAccessDefinition(String uri,
                                     String method,
                                     String role)
                              throws AccessException

Gets the access definition.

Parameters:

uri - the uri

method - the method

role - the role

Returns:

the access definition

Throws:

AccessException - the access exception

existsAccessDefinition

boolean existsAccessDefinition(String uri,
                               String method,
                               String role)
                        throws AccessException

Exists access definition.

Parameters:

uri - the uri

method - the method

role - the role

Returns:

true, if successful

Throws:

AccessException - the access exception

removeAccessDefinition

void removeAccessDefinition(long id)
                     throws AccessException

Removes the access definition.

Parameters:

id - the id

Throws:

AccessException - the access exception

updateAccessDefinition

void updateAccessDefinition(long id,
                            String location,
                            String uri,
                            String method,
                            String role,
                            String description)
                     throws AccessException

Update access definition.

Parameters:

id - the id

location - the location

uri - the uri

method - the method

role - the role

description - the description

Throws:

AccessException - the access exception

getAccessDefinitions

List<AccessDefinition> getAccessDefinitions()
                                     throws AccessException

Gets the access definitions.

Returns:

the access definitions

Throws:

AccessException - the access exception

getAccessDefinitionsByUri

List<AccessDefinition> getAccessDefinitionsByUri(String uri)
                                          throws AccessException

Gets the access definitions by uri.

Parameters:

uri - the uri

Returns:

the access definitions by uri

Throws:

AccessException - the access exception

getAccessDefinitionsByUriAndMethod

List<AccessDefinition> getAccessDefinitionsByUriAndMethod(String uri,
                                                          String method)
                                                   throws AccessException

Gets the access definitions by uri and method.

Parameters:

uri - the uri

method - the method

Returns:

the access definitions by uri and method

Throws:

AccessException - the access exception

isAccessAllowed

boolean isAccessAllowed(String uri,
                        String method,
                        String role)
                 throws AccessException

Checks if is access allowed.

Parameters:

uri - the uri

method - the method

role - the role

Returns:

true, if is access allowed

Throws:

AccessException - the access exception

parseRoles

RoleDefinition[] parseRoles(String json)

Parses the roles.

Parameters:

json - the json

Returns:

the role definition[]

parseRoles

RoleDefinition[] parseRoles(byte[] json)

Parses the roles.

Parameters:

json - the json

Returns:

the role definition[]

serializeRoles

String serializeRoles(RoleDefinition[] roles)

Serialize roles.

Parameters:

roles - the roles

Returns:

the string

parseAccessDefinitions

List<AccessDefinition> parseAccessDefinitions(String json)

Parses the access definitions.

Parameters:

json - the json

Returns:

the list

parseAccessDefinitions

List<AccessDefinition> parseAccessDefinitions(byte[] json)

Parses the access definitions.

Parameters:

json - the json

Returns:

the list

serializeAccessDefinitions

String serializeAccessDefinitions(List<AccessDefinition> accessDefinitions)

Serialize access definitions.

Parameters:

accessDefinitions - the access definitions

Returns:

the string