csbase.server.services.projectservice

Class ServerProject

java.lang.Object

csbase.server.services.projectservice.ServerProject

public class ServerProject
extends Object

Modela um projeto no servidor. Essa classe faz os acessos ao sistema de arquivos para fornecer/atualizar as informações relativas aos projetos.

Author:

Tecgraf/PUC-Rio

Field Summary

Fields

Modifier and Type	Field and Description
static String	INFO_EXTENSION Extensão dos arquivos de configuração dos projetos.

Method Summary

Modifier and Type	Method and Description
void	close(boolean notify) Notifica os usuários sobre o fechamento do projeto, mas não deve tirar ele de memória.
static ServerProject	createProject(csbase.logic.CommonProjectInfo info) Cria, abre e retorna um novo projeto.
static csbase.logic.CommonProjectInfo	createProjectInfo(File configFile) Monta o CommonProjectInfo com base no arquivo de controle.
static boolean	existsProject(Object projectId) Informa se um dado projeto existe.
static boolean	generateConfigFile(File configFile, Object ownerId, String projectName) Função para gerar um arquivo de controle de projetos CSBASE vazio com as informações básicas de nomes de usuário e projeto.
String	getAbsolutePath() Retorna o caminho absoluto para a raiz desse projeto.
static String	getAbsolutePath(Object projectId) Informa o caminho para o diretório raiz do projeto.
static List<Object>	getAllProjectIds(Object userId) Retorna os identificadores de todos os projetos de um usuário (apenas aqueles dos quais é dono, não inclui projetos aos quais apenas tem acesso).
Hashtable<String,Object>	getAttributes() Fornece os atributos específicos de um projeto.
protected static File	getConfigFile(File dir) Obtem o arquivo de configuração do projeto.
String	getDescription() Fornece a dscrição do projeto.
Object	getId() Fornece o identificador do projeto.
static Object	getId(Object userId, String projectName) Dado um usuário e um nome de projeto, obtém o identificador desse projeto.
csbase.logic.CommonProjectInfo	getInfo() Fornece informações do projeto.
String	getName() Fornece o nome do projeto.
static csbase.logic.User	getOwner(Object projectId) Obtém o usuário (Objeto User) a partir do project Id
static Object	getOwnerId(Object projectId) Dado um identificador de um projeto, obtém o usuário desse projeto.
static String	getOwnerLogin(Object projectId) Obtém o login do dono do projeto.
static String	getOwnerName(Object projectId) Dado um identificador de um projeto, obtém o nome do usuário desse projeto.
String	getOwnerServerName() Obtém o nome do servidor dono do projeto.
String[]	getPath() Fornece o caminho onde o projeto está instalado, a partir da raiz de todos os projetos.
static ServerProject	getProject(Object id) Recupera um projeto aberto de um usuário.
static String	getProjectName(Object projectId) Dado um identificador de um projeto, obtém o nome desse projeto.
List<ProjectTemplate>	getProjectTemplates() Obtém os templates do projeto.
csbase.logic.ProjectPermissions.SharingType	getSharingType() Obtém o tipo de compartilhamento.
csbase.server.services.projectservice.ServerProjectFile	getTree() Retorna o arquivo associado à raiz do projeto.
Object	getUserId() Fornece o identificador do usuário ao qual o projeto pertence.
Set<Object>	getUsersRO() Obtém a lista de usuários com acesso apenas de leitura ao projeto no modo de compartilhamento seletivo.
Set<Object>	getUsersRW() Obtém a lista de usuários com acesso de leitura e escrita ao projeto no modo de compartilhamento seletivo.
Boolean	isPublic() Vertifica se o projeto é público.
void	modify() Persiste as modificações feitas nas informações do projeto.
static ServerProject	openProject(Object projectId, boolean notify) Abre um projeto de um usuário.
static ServerProject	openServerProject(Object projectId)
static csbase.logic.CommonProjectInfo	readProjectInfoFromConfigFile(File configFile, Object ownerId) Gera o CommonProjectInfo de um projeto a partir de um File para seu arquivo de configuração.
void	rebuildTree() Reconstrói a árvore do projeto a partir do filesystem.
void	refreshTree() Sinaliza que a árvore do projeto deve ser atualizada.
void	remove() Remove o projeto.
static boolean	removeBasePrjDirForUser(Object userId) Remove o diretório-base dos projetos de um determinado usuário.
void	setAttributes(Hashtable<String,Object> attributes) Altera os atributos específicos do projeto.
void	setDescription(String description) Altera a descrição do projeto.
void	setName(String name) Altera o nome do projeto.
void	setSharingType(csbase.logic.ProjectPermissions.SharingType type) Define o tipo de compartilhamento.
void	setUsersRO(Set<Object> usersRO) Atualiza a lista de usuários com acesso apenas de leitura ao projeto.
void	setUsersRW(Set<Object> usersRW) Atualiza a lista de usuários com acesso de leitura e escrita ao projeto.
String	toString() Retorna um texto descritivo do projeto.
boolean	userHasAccess(Object userID) Verifica se o usuário tem acesso ao projeto.
boolean	userHasAccessRO(Object userID) Verifica se o usuário tem qualquer tipo de acesso RO ao projeto, ou seja, se uma das seguintes condições é satisfeita: o projeto é público apenas para leitura o compartilhamento é seletivo e o usuário possui acesso RO
boolean	userHasAccessRW(Object userID) Verifica se o usuário tem qualquer tipo de acesso RW ao projeto, ou seja, se uma das seguintes condições for satisfeita: usuário é o admin ou o dono do projeto este é público para leitura e escrita o compartilhamento é seletivo e o usuário possui acesso RW
static boolean	userHasHisOwnProjects(Object userId) Verifica se o usuário possui algum projeto.
boolean	userHasSelectiveAccessRO(Object userID) Verifica se o compartilhamento é seletivo e usuário tem acesso RO ao projeto.
boolean	userHasSelectiveAccessRW(Object userID) Verifica se o compartilhamento é seletivo e usuário tem acesso RW ao projeto.
boolean	userIsOwner(Object userID) Verifica se o usuário é o dono do projeto.

Methods inherited from class java.lang.Object

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

Field Detail

INFO_EXTENSION

public static final String INFO_EXTENSION

Extensão dos arquivos de configuração dos projetos.

See Also:

Constant Field Values

Method Detail

getId

public Object getId()

Fornece o identificador do projeto.

Returns:

Identificador do projeto.

getPath

public String[] getPath()

Fornece o caminho onde o projeto está instalado, a partir da raiz de todos os projetos.

Returns:

Caminho a partir da raiz dos projetos até este projeto

getAbsolutePath

public String getAbsolutePath()

Retorna o caminho absoluto para a raiz desse projeto.

Returns:

o caminho absoluto desse projeto

getId

public static Object getId(Object userId,
                           String projectName)

Dado um usuário e um nome de projeto, obtém o identificador desse projeto.

Parameters:

userId - Identificador do usuário dono do projeto.

projectName - Nome do projeto.

Returns:

O identificador do projeto.

See Also:

splitProjectId(Object)

getAbsolutePath

public static String getAbsolutePath(Object projectId)

Informa o caminho para o diretório raiz do projeto.

Parameters:

projectId - Identificador do projeto.

Returns:

O caminho para o diretório raiz do projeto.

getProjectName

public static String getProjectName(Object projectId)

Dado um identificador de um projeto, obtém o nome desse projeto.

Parameters:

projectId - O identificador do projeto.

Returns:

O nome do projeto.

getOwnerLogin

public static String getOwnerLogin(Object projectId)

Obtém o login do dono do projeto.

Parameters:

projectId - identificador do projeto

Returns:

login do dono do projeto

getOwnerId

public static Object getOwnerId(Object projectId)

Dado um identificador de um projeto, obtém o usuário desse projeto.

Parameters:

projectId - O indentificador do projeto.

Returns:

O usuário dono do projeto.

getOwnerName

public static String getOwnerName(Object projectId)

Dado um identificador de um projeto, obtém o nome do usuário desse projeto.

Parameters:

projectId - O indentificador do projeto.

Returns:

O nome usuário dono do projeto.

getOwner

public static csbase.logic.User getOwner(Object projectId)

Obtém o usuário (Objeto User) a partir do project Id

Parameters:

projectId - id do projeto.

Returns:

o usuário (objeto User) associado a este projectId

getOwnerServerName

public String getOwnerServerName()

Obtém o nome do servidor dono do projeto. Este nome está salvo na lista de propriedades de um projeto.

Returns:

O nome do servidor dono do projeto.

getConfigFile

protected static File getConfigFile(File dir)

Obtem o arquivo de configuração do projeto. Esse arquivo está associado ao diretório raiz do projeto.

Parameters:

dir - .

Returns:

.

getAllProjectIds

public static List<Object> getAllProjectIds(Object userId)

Retorna os identificadores de todos os projetos de um usuário (apenas aqueles dos quais é dono, não inclui projetos aos quais apenas tem acesso).

Parameters:

userId - Identificador do usuário.

Returns:

Array de identificadores dos projetos dos quais o usuário é dono.

userHasHisOwnProjects

public static boolean userHasHisOwnProjects(Object userId)

Verifica se o usuário possui algum projeto.

Parameters:

userId - identificador do usuário

Returns:

true se o usuário possui algum projeto próprio

removeBasePrjDirForUser

public static boolean removeBasePrjDirForUser(Object userId)

Remove o diretório-base dos projetos de um determinado usuário.

Parameters:

userId - Id do usuário

Returns:

true se removeu a pasta com sucesso ou se a pasta já não existia ou false caso a remoção tenha falhado.

existsProject

public static boolean existsProject(Object projectId)

Informa se um dado projeto existe.

Parameters:

projectId - Identificador do projeto.

Returns:

Verdadeiro caso exista, falso caso contrário.

openProject

public static ServerProject openProject(Object projectId,
                                        boolean notify)

Abre um projeto de um usuário. Verifica se o usuario que quer abrir o projeto participa dele.

Parameters:

projectId - Identificador do projeto.

notify - Indica se os clientes devem ser notificados.

Returns:

Objeto que representa o projeto.

openServerProject

public static ServerProject openServerProject(Object projectId)

getProject

public static ServerProject getProject(Object id)

Recupera um projeto aberto de um usuário. Se o projeto não estiver aberto, retorna null.

Parameters:

id - Identificador do projeto.

Returns:

Objeto que representa o projeto ou null caso o projeto não esteja aberto.

createProject

public static ServerProject createProject(csbase.logic.CommonProjectInfo info)

Cria, abre e retorna um novo projeto.

Parameters:

info - Informações do projeto.

Returns:

o projeto criado

generateConfigFile

public static boolean generateConfigFile(File configFile,
                                         Object ownerId,
                                         String projectName)

Função para gerar um arquivo de controle de projetos CSBASE vazio com as informações básicas de nomes de usuário e projeto.

Parameters:

configFile - arquivo de controle a ser gerado.

ownerId - identificador do usuário dono do projeto.

projectName - nome do projeto.

Returns:

indicativo de sucesso na criação.

createProjectInfo

public static csbase.logic.CommonProjectInfo createProjectInfo(File configFile)

Monta o CommonProjectInfo com base no arquivo de controle.

Parameters:

configFile - arquivo de controle

Returns:

objeto de controle ou null caso isso não seja possível.

readProjectInfoFromConfigFile

public static csbase.logic.CommonProjectInfo readProjectInfoFromConfigFile(File configFile,
                                                                           Object ownerId)

Gera o CommonProjectInfo de um projeto a partir de um File para seu arquivo de configuração.

Parameters:

configFile - File para arquivo de configuração.

ownerId - Dono do projeto.

Returns:

CommonProjectInfo do projeto.

getInfo

public csbase.logic.CommonProjectInfo getInfo()

Fornece informações do projeto.

Returns:

CommonProjectInfo info.

getUserId

public Object getUserId()

Fornece o identificador do usuário ao qual o projeto pertence.

Returns:

Identificador do usuário.

getName

public String getName()

Fornece o nome do projeto.

Returns:

Nome do projeto.

setName

public void setName(String name)

Altera o nome do projeto. Essa modificação só será persistida quando o método modify() for chamado.

Parameters:

name - nome.

getDescription

public String getDescription()

Fornece a dscrição do projeto.

Returns:

A descrição do projeto.

setDescription

public void setDescription(String description)

Altera a descrição do projeto. Essa modificação só será persistida quando o método modify() for chamado.

Parameters:

description - descrição.

getAttributes

public Hashtable<String,Object> getAttributes()

Fornece os atributos específicos de um projeto. Por exemplo, o sistema de coordenadas do websintesi.

Returns:

Atributos do projeto.

setAttributes

public void setAttributes(Hashtable<String,Object> attributes)

Altera os atributos específicos do projeto. Essa modificação só será persistida quando o método modify() for chamado.

Parameters:

attributes - do projeto.

getTree

public csbase.server.services.projectservice.ServerProjectFile getTree()

Retorna o arquivo associado à raiz do projeto.

IMPORTANTE: não se deve assumir que a árvore está preenchida, só é garantido que o nó-raiz esteja definido

Returns:

arquivo associado à raiz do projeto. Seus filhos podem não ter sido ainda definidos

setUsersRO

public void setUsersRO(Set<Object> usersRO)

Atualiza a lista de usuários com acesso apenas de leitura ao projeto.

Parameters:

usersRO - - usuários com acesso apenas de leitura ao projeto

setUsersRW

public void setUsersRW(Set<Object> usersRW)

Atualiza a lista de usuários com acesso de leitura e escrita ao projeto.

Parameters:

usersRW - - usuários com acesso apenas de leitura e escrita ao projeto

isPublic

public Boolean isPublic()

Vertifica se o projeto é público.

Returns:

true, caso o projeto seja público, ou false, caso contrário.

setSharingType

public void setSharingType(csbase.logic.ProjectPermissions.SharingType type)

Define o tipo de compartilhamento.

Parameters:

type - - tipo de compartilhamento

getProjectTemplates

public List<ProjectTemplate> getProjectTemplates()

Obtém os templates do projeto.

Returns:

a lista de templates.

getSharingType

public csbase.logic.ProjectPermissions.SharingType getSharingType()

Obtém o tipo de compartilhamento.

Returns:

tipo do compartilhamento

getUsersRO

public Set<Object> getUsersRO()

Obtém a lista de usuários com acesso apenas de leitura ao projeto no modo de compartilhamento seletivo.

IMPORTANTE: este método não leva em consideração o tipo de compartilhamento do projeto, i.e. pode retornar uma lista não-vazia mesmo que o compartilhamento seja público ou privado.

Returns:

lista de usuários com acesso apenas de leitura no modo de compartilhamento seletivo. Caso não existam usuários nesta condição, retorna uma lista vazia.

getUsersRW

public Set<Object> getUsersRW()

Obtém a lista de usuários com acesso de leitura e escrita ao projeto no modo de compartilhamento seletivo.

IMPORTANTE: este método não leva em consideração o tipo de compartilhamento do projeto, i.e. pode retornar uma lista não-vazia mesmo que o compartilhamento seja público ou privado.

Returns:

lista de usuários com acesso de leitura e escrita no modo de compartilhamento seletivo. Caso não existam usuários nesta condição, retorna uma lista vazia.

userHasAccess

public boolean userHasAccess(Object userID)

Verifica se o usuário tem acesso ao projeto. Isto acontece se qualquer uma das opções seguintes é satisfeita:

• projeto é público (RO ou RW)
• usuário é o dono do projeto ou o admin
• compartilhamento é seletivo e o usuário tem acesso RO ou RW ao projeto

Parameters:

userID - - identificador do usuário

Returns:

true se o usuário tem acesso ao projeto (RO ou RW)

userHasAccessRO

public boolean userHasAccessRO(Object userID)

Verifica se o usuário tem qualquer tipo de acesso RO ao projeto, ou seja, se uma das seguintes condições é satisfeita:

• o projeto é público apenas para leitura
• o compartilhamento é seletivo e o usuário possui acesso RO

Parameters:

userID - - identificador do usuário

Returns:

true se o usuário tem qualquer tipo de acesso RO ao projeto

userHasAccessRW

public boolean userHasAccessRW(Object userID)

Verifica se o usuário tem qualquer tipo de acesso RW ao projeto, ou seja, se uma das seguintes condições for satisfeita:

• usuário é o admin ou o dono do projeto
• este é público para leitura e escrita
• o compartilhamento é seletivo e o usuário possui acesso RW

Parameters:

userID - - identificador do usuário

Returns:

true se o usuário tem acesso RW ao projeto

userHasSelectiveAccessRO

public boolean userHasSelectiveAccessRO(Object userID)

Verifica se o compartilhamento é seletivo e usuário tem acesso RO ao projeto.

Parameters:

userID - - identificador do usuário

Returns:

true se o compartilhamento é seletivo e o usuário tem acesso RO ao projeto

userHasSelectiveAccessRW

public boolean userHasSelectiveAccessRW(Object userID)

Verifica se o compartilhamento é seletivo e usuário tem acesso RW ao projeto.

Parameters:

userID - - identificador do usuário

Returns:

true se o compartilhamento é seletivo e o usuário tem acesso RW ao projeto

userIsOwner

public boolean userIsOwner(Object userID)

Verifica se o usuário é o dono do projeto.

Parameters:

userID - - identificador do usuário

Returns:

true se o usuário é o dono do projeto

modify

public void modify()

Persiste as modificações feitas nas informações do projeto. Caso alguma informação não possa ser alterada, seu valor original será reestabelecido. Notifica os observadores que ocorreu uma mudança nas informações do projeto.

refreshTree

public void refreshTree()

Sinaliza que a árvore do projeto deve ser atualizada. O evento é enviado apenas com a raiz da árvore, sem os filhos (mas com a informação de se este possui filhos).

See Also:

rebuildTree()

rebuildTree

public void rebuildTree()

Reconstrói a árvore do projeto a partir do filesystem. Todos os nós são lidos recursivamente.

IMPORTANTE: esta operação é custosa para projetos com muitos arquivos. Apenas os arquivos de controle do CSBase são descartados, todos os demais arquivos e diretórios serão percorridos. O evento enviado em resposta contém a raiz da árvore, que está completamente preenchida.

See Also:

refreshTree()

remove

public void remove()

Remove o projeto. Caso este método retorne com sucesso, o objeto que representa o projeto não poderá mais ser utilizado.

close

public void close(boolean notify)

Notifica os usuários sobre o fechamento do projeto, mas não deve tirar ele de memória. Olhar pendência 377. Vai ser corrigida com a reimplentação do serviço de projetos.

Parameters:

notify - indicativo de notificação aos clientes.

toString

public String toString()

Retorna um texto descritivo do projeto.

Overrides:

toString in class Object

Returns:

.