csbase.remote

Interface AdministrationServiceInterface

All Superinterfaces:

Remote, RemoteObservable, ServiceInterface, TransactionInterface

public interface AdministrationServiceInterface
extends TransactionInterface, ServiceInterface, RemoteObservable

Define a interface remota do serviço de acesso a usuários, grupos de usuários, perfis e plataformas.

Author:

Tecgraf/PUC-Rio

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME Nome do serviço para o ServiceManager

Method Summary

Modifier and Type	Method and Description
Permission	createPermission(Permission permission) Cria uma nova permissão no sistema.
Platform	createPlatform(PlatformInfo info) Cria uma nova plataforma no sistema.
Role	createRole(RoleInfo info) Cria um novo perfil no sistema.
User	createUser(UserInfo info) Cria um novo usuário no sistema.
UserGroup	createUserGroup(UserGroupInfo info) Cria um novo UserGroup no sistema.
void	deletePermission(Object id) Remove uma permissão do sistema.
void	deletePlatform(Object id) Remove uma plataforma
void	deleteRole(Object id) Remove um perfil do sistema.
void	deleteUser(Object id) Remove um usuário do sistema.
void	deleteUserGroup(Object id) Remove um UserGroup do sistema.
List<Permission>	getAllPermissions() Obtém todas as permissões cadastradas no sistema.
List<Permission>	getAllPermissionsWithPasswords() Obtém todas as permissões cadastradas no sistema, com eventuais senhas que elas possuam.
List<Platform>	getAllPlatforms() Obtém todas as plataformas cadastradas no sistema.
List<Role>	getAllRoles() Obtém todos os perfis cadastrados no sistema.
List<UserGroup>	getAllUserGroups() Obtém uma lista de todas os UserGroups do sistema.
List<UserOutline>	getAllUserOutlines() Obtém uma lista de informações sumarizadas de todos os usuários do sistema.
List<User>	getAllUsers() Obtém um vetor de todos os usuários do sistema.
List<UserUpdate>	getAllUserUpdates() Obtém uma lista de informações sumarizadas necessárias para fazer a atualização de uma cópia do repositório de usuários.
Locale	getCurrentLocale() Obtem o locale configurado no sistema
Permission	getPermission(Object id) Obtém uma permissão que possui uma determinada identificação.
List<String>	getPermissionClasses() Obtém os nomes de todas as classes concretas de permissões utilizadas no sistema.
Permission	getPermissionWithPassword(Object id) Obtém uma permissão que possui uma determinada identificação.
ImageIcon	getPhoto(Object id) Busca a foto de um usuário.
File	getPhotoFile(Object id) Retorna o arquivo com a foto de um usuário.
Platform	getPlatform(Object id) Obtém a plataforma que possui o identificador especificado.
Role	getRole(Object id) Obtém um perfil que possui uma determinada identificação.
User	getUser(Object id) Obtém um usuário que possui uma determinada identificação.
UserGroup	getUserGroup(Object id) Obtém um UserGroup que possui uma determinada identificação.
Permission	modifyPermission(Object id, Permission permission) Modifica uma permissão no sistema.
Platform	modifyPlatform(Object id, PlatformInfo info) Modifica uma plataforma no sistema.
Role	modifyRole(Object id, RoleInfo info) Modifica um perfil no sistema.
User	modifyUser(Object id, UserInfo info) Modifica um usuário no sistema.
UserGroup	modifyUserGroup(Object id, UserGroupInfo info) Modifica um UserGroup no sistema.
void	setLocale(Locale locale) Atribui um locale a thread corrente.
void	setPhotoFile(String id, InputStream photo, String fileName) Altera o arquivo com a foto de um usuário.

Methods inherited from interface csbase.remote.TransactionInterface

isLocked, lock, unlock

Methods inherited from interface csbase.remote.ServiceInterface

getName, isActive

Methods inherited from interface csbase.remote.RemoteObservable

addObserver, countObservers, deleteObserver, deleteObservers, notifyObservers

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

Nome do serviço para o ServiceManager

See Also:

Constant Field Values

Method Detail

getAllUsers

List<User> getAllUsers()
                throws RemoteException

Obtém um vetor de todos os usuários do sistema. Essas informações são representadas por objetos da classe User.

Returns:

um vetor com todos os usuários

Throws:

RemoteException - em caso de erro.

getAllUserUpdates

List<UserUpdate> getAllUserUpdates()
                            throws RemoteException

Obtém uma lista de informações sumarizadas necessárias para fazer a atualização de uma cópia do repositório de usuários. Essas informações são representadas por objetos da classe UserUpdate.

Returns:

um vetor com os resumos de atualização de todos os usuários

Throws:

RemoteException - em caso de erro.

getAllUserOutlines

List<UserOutline> getAllUserOutlines()
                              throws RemoteException

Obtém uma lista de informações sumarizadas de todos os usuários do sistema.

Returns:

um vetor com informações de usuários

Throws:

RemoteException - em caso de erro.

getUser

User getUser(Object id)
      throws RemoteException

Obtém um usuário que possui uma determinada identificação.

Parameters:

id - a identificação de um usuário

Returns:

o usuário que possui a identificação requisitada ou null caso esse usuário não exista

Throws:

RemoteException - em caso de erro.

createUser

User createUser(UserInfo info)
         throws RemoteException

Cria um novo usuário no sistema. Não podem existir dois usuários com o mesmo login.

Parameters:

info - os dados do usuário a ser incluído

Returns:

o novo usuário

Throws:

RemoteException - em caso de erro.

getPhoto

ImageIcon getPhoto(Object id)
            throws RemoteException

Busca a foto de um usuário.

Parameters:

id - a identificação do usuário a ser modificado

Returns:

a imagem

Throws:

RemoteException - em caso de erro.

getPhotoFile

File getPhotoFile(Object id)
           throws RemoteException

Retorna o arquivo com a foto de um usuário.

Parameters:

id - a identificação do usuário

Returns:

o arquivo ou null caso não exista

Throws:

RemoteException - em caso de erro.

setPhotoFile

void setPhotoFile(String id,
                  InputStream photo,
                  String fileName)

Altera o arquivo com a foto de um usuário.

Parameters:

id - a identificação do usuário

photo - o arquivo com a nova foto

fileName - o nome do arquivo da foto

modifyUser

User modifyUser(Object id,
                UserInfo info)
         throws RemoteException

Modifica um usuário no sistema. Não é permitido mudar o login de um usuário.

Parameters:

id - a identificação do usuário a ser modificado

info - o dados a serem usuados na modificação desse usuário

Returns:

o usuário após a modificação

Throws:

RemoteException - em caso de erro.

deleteUser

void deleteUser(Object id)
         throws RemoteException,
                AdministrationDeleteException

Remove um usuário do sistema.

Parameters:

id - o identificador do usuário a ser removido do sistema.

Throws:

RemoteException - falha de rmi

AdministrationDeleteException - se o usuário possuir projetos

getAllUserGroups

List<UserGroup> getAllUserGroups()
                          throws RemoteException

Obtém uma lista de todas os UserGroups do sistema.

Returns:

um vetor com os UserGroups

Throws:

RemoteException - em caso de erro.

getUserGroup

UserGroup getUserGroup(Object id)
                throws RemoteException

Obtém um UserGroup que possui uma determinada identificação.

Parameters:

id - a identificação de um UserGroup

Returns:

o UserGroup que possui a identificação requisitada ou null caso ele não exista

Throws:

RemoteException - em caso de erro.

createUserGroup

UserGroup createUserGroup(UserGroupInfo info)
                   throws RemoteException

Cria um novo UserGroup no sistema. Não podem existir dois UserGroups com o mesmo nome.

Parameters:

info - os dados do grupo de usuários a ser incluído

Returns:

o grupo de usuários criado

Throws:

RemoteException - em caso de erro.

modifyUserGroup

UserGroup modifyUserGroup(Object id,
                          UserGroupInfo info)
                   throws RemoteException

Modifica um UserGroup no sistema. Não é possível mudar o nome de um UserGroup se já existir outro com esse mesmo nome.

Parameters:

id - o identificador do UserGroup a ser modificado

info - os dados da grupo de usuários a ser modificado

Returns:

o grupo de usuários modificado

Throws:

RemoteException - em caso de erro.

deleteUserGroup

void deleteUserGroup(Object id)
              throws RemoteException,
                     AdministrationDeleteException

Remove um UserGroup do sistema.

Parameters:

id - a identificação do grupo de usuários a ser removido do sistema.

Throws:

AdministrationDeleteException - erro levantado quando existe usuario associado com o UserGroup.

RemoteException - em caso de erro.

getAllRoles

List<Role> getAllRoles()
                throws RemoteException

Obtém todos os perfis cadastrados no sistema.

Returns:

vetor com os perfis

Throws:

RemoteException - em caso de erro.

getRole

Role getRole(Object id)
      throws RemoteException

Obtém um perfil que possui uma determinada identificação.

Parameters:

id - a identificação de um perfil

Returns:

o perfil que possui a identificação requisitada

Throws:

RemoteException - em caso de erro.

createRole

Role createRole(RoleInfo info)
         throws RemoteException

Cria um novo perfil no sistema.

Parameters:

info - as informações do novo perfil.

Returns:

o perfil criado

Throws:

RemoteException - em caso de erro.

modifyRole

Role modifyRole(Object id,
                RoleInfo info)
         throws RemoteException

Modifica um perfil no sistema.

Parameters:

id - - identificador do perfil a ser modificado

info - as informações a serem usadas na modificação do perfil.

Returns:

o perfil modificado

Throws:

RemoteException - em caso de erro.

deleteRole

void deleteRole(Object id)
         throws RemoteException,
                AdministrationDeleteException

Remove um perfil do sistema.

Parameters:

id - o identificador do perfil a ser removido do sistema.

Throws:

AdministrationDeleteException - erro levantado quando existe usuario associado com o perfil.

RemoteException - em caso de erro.

getPermissionClasses

List<String> getPermissionClasses()
                           throws RemoteException

Obtém os nomes de todas as classes concretas de permissões utilizadas no sistema.

Returns:

vetor com os nomes das classes de permissões

Throws:

RemoteException - em caso de erro.

getAllPermissions

List<Permission> getAllPermissions()
                            throws RemoteException

Obtém todas as permissões cadastradas no sistema.

Returns:

vetor com as permissões

Throws:

RemoteException - em caso de erro.

getAllPermissionsWithPasswords

List<Permission> getAllPermissionsWithPasswords()
                                         throws RemoteException

Obtém todas as permissões cadastradas no sistema, com eventuais senhas que elas possuam. Este método é utilizado por servidores locais, logados como admin, para fazer a sincronização das bases de permissões. Todas as permissões do tipo UserPasswordPermission retornadas por este método têm a senha guardada no campo password.

Returns:

vetor com as permissões

Throws:

RemoteException - em caso de erro.

getPermission

Permission getPermission(Object id)
                  throws RemoteException

Obtém uma permissão que possui uma determinada identificação.

Parameters:

id - a identificação de uma permissão

Returns:

a permissão que possui a identificação requisitada

Throws:

RemoteException - em caso de erro.

getPermissionWithPassword

Permission getPermissionWithPassword(Object id)
                              throws RemoteException

Obtém uma permissão que possui uma determinada identificação. Este método é utilizado por servidores locais, logados como admin, para fazer a sincronização das bases de permissões. Toda permissão do tipo UserPasswordPermission retornada por este método tem a senha guardada no campo password.

Parameters:

id - a identificação de uma permissão

Returns:

a permissão que possui a identificação requisitada, com senha

Throws:

RemoteException - em caso de erro.

createPermission

Permission createPermission(Permission permission)
                     throws RemoteException

Cria uma nova permissão no sistema.

Parameters:

permission - a nova permissão.

Returns:

a permissão criada

Throws:

RemoteException - em caso de erro.

modifyPermission

Permission modifyPermission(Object id,
                            Permission permission)
                     throws RemoteException

Modifica uma permissão no sistema.

Parameters:

id - o identificador da permissão a ser alterada.

permission - a nova versão da permissão.

Returns:

a permissão modificada

Throws:

RemoteException - em caso de erro.

deletePermission

void deletePermission(Object id)
               throws RemoteException,
                      AdministrationDeleteException

Remove uma permissão do sistema.

Parameters:

id - o identificador da permissão a ser removida do sistema.

Throws:

AdministrationDeleteException - erro levantado quando existe usuario ou um perfil utilizando a permissão.

RemoteException - em caso de erro.

getAllPlatforms

List<Platform> getAllPlatforms()
                        throws RemoteException

Obtém todas as plataformas cadastradas no sistema.

Returns:

vetor com as plataformas

Throws:

RemoteException - em caso de erro.

getPlatform

Platform getPlatform(Object id)
              throws RemoteException

Obtém a plataforma que possui o identificador especificado.

Parameters:

id - identificador da plataforma

Returns:

plataforma que possui o identificador especificado ou null caso essa plataforma não exista

Throws:

RemoteException - em caso de erro.

createPlatform

Platform createPlatform(PlatformInfo info)
                 throws RemoteException

Cria uma nova plataforma no sistema.

Parameters:

info - as informações da nova plataforma

Returns:

plataforma criada

Throws:

RemoteException - em caso de erro.

modifyPlatform

Platform modifyPlatform(Object id,
                        PlatformInfo info)
                 throws RemoteException

Modifica uma plataforma no sistema.

Parameters:

id - identificador da plataforma a ser modificada

info - as novas informações da plataforma

Returns:

plataforma modificada

Throws:

RemoteException - em caso de erro.

deletePlatform

void deletePlatform(Object id)
             throws RemoteException

Remove uma plataforma

Parameters:

id - identificador da plataforma a ser removida

Throws:

RemoteException - em caso de erro.

setLocale

void setLocale(Locale locale)

Atribui um locale a thread corrente. .

Parameters:

locale - o locale para um idioma.

getCurrentLocale

Locale getCurrentLocale()

Obtem o locale configurado no sistema

Returns:

o locale do sistema