net.anotheria.portalkit.adminapi.api.admin

Interface AdminAPI

All Superinterfaces:

net.anotheria.anoplass.api.API

All Known Implementing Classes:

AdminAPIImpl

public interface AdminAPI
extends net.anotheria.anoplass.api.API

API that provides basic admin functionality.

Method Summary

Modifier and Type	Method and Description
AdminAccountAO	addAccountStatus(AccountId accountId, int status) Adds a status to provided account
DataspaceAO	createDataspace(AccountId accountId, int dataspaceId, java.util.List<DataspaceAttributeAO> attributes) Creates dataspace with for account with specific id and attributes.
void	deleteDataspace(AccountId accountId, int dataspaceId) Removes dataspace completely by account and dataspace id.
AdminAccountAO	getAccountById(AccountId accountId) Returns account by accountId
PageResult<AdminAccountAO>	getAccounts(AccountsGetRequest request) Returns paginated list of created in system accounts.
PageResult<AdminAccountAO>	getAccounts(int pageNumber, int itemsOnPage, java.lang.String searchTerm) Returns paginated list of created in system accounts.
java.util.List<AdminAPIConfig.AccountStatusConfig>	getAccountStatuses() Returns all account statuses
java.util.List<AdminAPIConfig.AccountTypeConfig>	getAccountTypes() Returns all account types
java.util.List<DataspaceAO>	getAllDataspaces(AccountId accountId) Returns all account's dataspaces
java.util.List<AdminAPIConfig.DataspaceConfig>	getDataspaces()
java.lang.String	getSignAsToken(AccountId accountId) Creates a token that can be used to log in as provided user.
AdminAccountAO	removeAccountStatus(AccountId accountId, int status) Removes a status from provided account
DataspaceAO	removeDataspaceAttribute(AccountId accountId, int dataspaceId, java.lang.String attributeName) Removes an attribute from existing dataspace.
DataspaceAO	saveDataspaceAttribute(AccountId accountId, int dataspaceId, java.lang.String attributeName, java.lang.String attributeValue, AttributeType type) Saves an attribute to existing dataspace.
void	setNewAccountPassword(AccountId accountId, java.lang.String newPassword) Sets a new password for provided account
AdminAccountAO	updateAccount(AccountUpdateRequest updateRequest) Updates account information.

Methods inherited from interface net.anotheria.anoplass.api.API

deInit, init

Method Detail

getAccountStatuses

java.util.List<AdminAPIConfig.AccountStatusConfig> getAccountStatuses()
                                                               throws net.anotheria.anoplass.api.APIException

Returns all account statuses

Returns:

list of AdminAPIConfig.AccountStatusConfig

Throws:

net.anotheria.anoplass.api.APIException - in case of error

getAccountTypes

java.util.List<AdminAPIConfig.AccountTypeConfig> getAccountTypes()
                                                          throws net.anotheria.anoplass.api.APIException

Returns all account types

Returns:

list of AdminAPIConfig.AccountTypeConfig

Throws:

net.anotheria.anoplass.api.APIException - in case of error

getAccounts

PageResult<AdminAccountAO> getAccounts(int pageNumber,
                                       int itemsOnPage,
                                       java.lang.String searchTerm)
                                throws net.anotheria.anoplass.api.APIException

Returns paginated list of created in system accounts.

Parameters:

pageNumber - number of page

itemsOnPage - amount of items on page

searchTerm - some term like email, name to filter accounts

Returns:

list of paginated AdminAccountAO

Throws:

net.anotheria.anoplass.api.APIException - in case of error

getAccounts

PageResult<AdminAccountAO> getAccounts(AccountsGetRequest request)
                                throws net.anotheria.anoplass.api.APIException

Returns paginated list of created in system accounts.

Parameters:

request - criteria request

Returns:

list of paginated AdminAccountAO

Throws:

net.anotheria.anoplass.api.APIException - in case of error

getAccountById

AdminAccountAO getAccountById(AccountId accountId)
                       throws net.anotheria.anoplass.api.APIException

Returns account by accountId

Parameters:

accountId - accountId

Returns:

AdminAccountAO

Throws:

net.anotheria.anoplass.api.APIException - in case of error

updateAccount

AdminAccountAO updateAccount(AccountUpdateRequest updateRequest)
                      throws net.anotheria.anoplass.api.APIException

Updates account information. Only email, name, brand, type or tenant can be updated.

Parameters:

updateRequest - AccountUpdateRequest

Returns:

AdminAccountAO

Throws:

net.anotheria.anoplass.api.APIException - in case of error

addAccountStatus

AdminAccountAO addAccountStatus(AccountId accountId,
                                int status)
                         throws net.anotheria.anoplass.api.APIException

Adds a status to provided account

Parameters:

accountId - accountId

status - status to add

Returns:

AdminAccountAO

Throws:

net.anotheria.anoplass.api.APIException - in case of error

removeAccountStatus

AdminAccountAO removeAccountStatus(AccountId accountId,
                                   int status)
                            throws net.anotheria.anoplass.api.APIException

Removes a status from provided account

Parameters:

accountId - accountId

status - status to remove

Returns:

AdminAccountAO

Throws:

net.anotheria.anoplass.api.APIException - in case of error

setNewAccountPassword

void setNewAccountPassword(AccountId accountId,
                           java.lang.String newPassword)
                    throws net.anotheria.anoplass.api.APIException

Sets a new password for provided account

Parameters:

accountId - accountId

newPassword - new password to set

Throws:

net.anotheria.anoplass.api.APIException - in case of error

getSignAsToken

java.lang.String getSignAsToken(AccountId accountId)
                         throws net.anotheria.anoplass.api.APIException

Creates a token that can be used to log in as provided user.

Parameters:

accountId - account whose token will be created to perform log in

Returns:

authToken

Throws:

net.anotheria.anoplass.api.APIException - in case of error

getDataspaces

java.util.List<AdminAPIConfig.DataspaceConfig> getDataspaces()
                                                      throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

getAllDataspaces

java.util.List<DataspaceAO> getAllDataspaces(AccountId accountId)

Returns all account's dataspaces

Parameters:

accountId - dataspaces owner

Returns:

DataspaceAO

createDataspace

DataspaceAO createDataspace(AccountId accountId,
                            int dataspaceId,
                            java.util.List<DataspaceAttributeAO> attributes)
                     throws net.anotheria.anoplass.api.APIException

Creates dataspace with for account with specific id and attributes.

Parameters:

accountId - owner of dataspace

dataspaceId - id of dataspace

attributes - list of attributes

Returns:

DataspaceAO

Throws:

net.anotheria.anoplass.api.APIException

saveDataspaceAttribute

DataspaceAO saveDataspaceAttribute(AccountId accountId,
                                   int dataspaceId,
                                   java.lang.String attributeName,
                                   java.lang.String attributeValue,
                                   AttributeType type)
                            throws net.anotheria.anoplass.api.APIException

Saves an attribute to existing dataspace. If there is no dataspace with provided id, exception will be thrown.

Parameters:

accountId - dataspace owner

dataspaceId - id of dataspace

attributeName - name of attribute

attributeValue - value of attribute

type - type of attribute

Returns:

DataspaceAO

Throws:

net.anotheria.anoplass.api.APIException - in case of error

removeDataspaceAttribute

DataspaceAO removeDataspaceAttribute(AccountId accountId,
                                     int dataspaceId,
                                     java.lang.String attributeName)
                              throws net.anotheria.anoplass.api.APIException

Removes an attribute from existing dataspace. If there is no dataspace with provided id, exception will be thrown.

Parameters:

accountId - dataspace owner

dataspaceId - id of dataspace

attributeName - name of attribute

Returns:

DataspaceAO

Throws:

net.anotheria.anoplass.api.APIException - in case of error

deleteDataspace

void deleteDataspace(AccountId accountId,
                     int dataspaceId)
              throws net.anotheria.anoplass.api.APIException

Removes dataspace completely by account and dataspace id.

Parameters:

accountId - dataspace owner

dataspaceId - dataspace type (id)

Throws:

net.anotheria.anoplass.api.APIException