Package com.soffid.iam.base.service

Interface TenantService

public interface TenantService

Service TenantService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
void	addTenantServer(Tenant tenant, String server)	Operation addTenantServer Adds a server to a tenant
Tenant	create(Tenant tenant)	Operation create Create a new tenant
void	disablePermission(Tenant tenant, String permission)	Operation disablePermission Disables a permission on a tenant
void	enablePermission(Tenant tenant, String permission)	Operation enablePermission Enables a permission on a tenant
void	exportTenant(Tenant tenant, OutputStream out)	Operation exportTenant Exports tenant to a file
List<String>	getDisabledPermissions(Tenant tenant)	Operation getDisabledPermissions Gets the list of disabled permissions for a tenant
Tenant	getMasterTenant()	Operation getMasterTenant Gets master tenant
Tenant	getTenant(Long id)	Operation getTenant Finds a tenant by name.
Tenant	getTenant(String name)	Operation getTenant Finds a tenant by name.
List<String>	getTenantServers(Tenant tenant)	Operation getTenantServers Gets the list of servers for a tenant
Tenant	importTenant(InputStream in)	Operation importTenant Ipmorts a tenant to a file
Collection<Tenant>	listTenants()	Operation listTenants List allowed tenant.
void	remove(Tenant tenant)	Operation remove Remove at tenant
void	removeTenantServer(Tenant tenant, String server)	Operation removeTenantServer Removes a server for a tenant
Tenant	update(Tenant tenant)	Operation update Updates a tenant

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

Method Details

importTenant

Tenant importTenant(InputStream in)
             throws InternalErrorException

Operation importTenant Ipmorts a tenant to a file

Parameters:

in -

Returns:

Throws:

InternalErrorException

create

Tenant create(Tenant tenant)
       throws InternalErrorException

Operation create Create a new tenant

Parameters:

tenant -

Returns:

Throws:

InternalErrorException

getMasterTenant

Tenant getMasterTenant()
                throws InternalErrorException

Operation getMasterTenant Gets master tenant

Returns:

Throws:

InternalErrorException

getTenant

Tenant getTenant(Long id)
          throws InternalErrorException

Operation getTenant Finds a tenant by name. Used mainly internally

Parameters:

id -

Returns:

Throws:

InternalErrorException

getTenant

Tenant getTenant(String name)
          throws InternalErrorException

Operation getTenant Finds a tenant by name. Used mainly internally

Parameters:

name -

Returns:

Throws:

InternalErrorException

update

Tenant update(Tenant tenant)
       throws InternalErrorException

Operation update Updates a tenant

Parameters:

tenant -

Returns:

Throws:

InternalErrorException

listTenants

Collection<Tenant> listTenants()
                        throws InternalErrorException

Operation listTenants List allowed tenant. Open to anybody, as everybody can query its own tenant, at least

Returns:

Throws:

InternalErrorException

getDisabledPermissions

List<String> getDisabledPermissions(Tenant tenant)
                             throws InternalErrorException

Operation getDisabledPermissions Gets the list of disabled permissions for a tenant

Parameters:

tenant -

Returns:

Throws:

InternalErrorException

getTenantServers

List<String> getTenantServers(Tenant tenant)
                       throws InternalErrorException

Operation getTenantServers Gets the list of servers for a tenant

Parameters:

tenant -

Returns:

Throws:

InternalErrorException

addTenantServer

void addTenantServer(Tenant tenant,
 String server)
              throws InternalErrorException

Operation addTenantServer Adds a server to a tenant

Parameters:

tenant -

server -

Throws:

InternalErrorException

disablePermission

void disablePermission(Tenant tenant,
 String permission)
                throws InternalErrorException

Operation disablePermission Disables a permission on a tenant

Parameters:

tenant -

permission -

Throws:

InternalErrorException

enablePermission

void enablePermission(Tenant tenant,
 String permission)
               throws InternalErrorException

Operation enablePermission Enables a permission on a tenant

Parameters:

tenant -

permission -

Throws:

InternalErrorException

remove

void remove(Tenant tenant)
     throws InternalErrorException

Operation remove Remove at tenant

Parameters:

tenant -

Throws:

InternalErrorException

removeTenantServer

void removeTenantServer(Tenant tenant,
 String server)
                 throws InternalErrorException

Operation removeTenantServer Removes a server for a tenant

Parameters:

tenant -

server -

Throws:

InternalErrorException

exportTenant

void exportTenant(Tenant tenant,
 OutputStream out)
           throws InternalErrorException

Operation exportTenant Exports tenant to a file

Parameters:

tenant -

out -

Throws:

InternalErrorException