csbase.server.services.xmlconversionservice

Class XMLConversionService

java.lang.Object

csbase.remote.RemoteObjectObservable

csbase.server.ServerRemoteObjectObservable

csbase.server.Service

csbase.server.services.xmlconversionservice.XMLConversionService

All Implemented Interfaces:

csbase.remote.RemoteObservable, csbase.remote.RemoteObserverNotifierInterface, csbase.remote.ServiceInterface, csbase.remote.XMLConversionServiceInterface, csbase.server.plugin.service.IService, Remote

public class XMLConversionService
extends Service
implements csbase.remote.XMLConversionServiceInterface

A classe XMLConversionService implementa o serviço de conversão de arquivos XML. Este serviço é usado para converter arquivos XML para torná-los compatíveis com a última versão do DTD. Isto é feito usando-se conversores XML

IMPORTANTE (1): Este serviço deverá ser usado como um super-serviço para conversões de aplicações específicas. Assim, não deverá ser instanciado (createService()) diretamente, mas sim os sub-serviços (sub-classes deste), que deverão implementar o createService() retornando uma instância de sua classe específica. Outras duas obrigatoriedades para sub-classes deste são: 1 - implementar o método createConverter(String) para retornar o convertedor xml específico de sua aplicação e 2 - declarar que o sub-serviço específico implementa XMLConversionServiceInterface (caso contrário, o ProxyUtils, que só verifica as interfaces diretamente implementadas dará um erro, indicando que o sub-serviço não implementa nenhuma interface de serviço remoto). Opcionalmente, o sub-serviço poderá implementar o método postConvert() para executar operações específicas de pós conversão. No projeto MARLIM há um exemplo (MarlimXMLConversionService) que pode ser usado como exemplo

IMPORTANTE (2): atualmente somos forçados a sobrescrever o arquivo original (é possível antes fazer um backup) pois o CSBase não permite transmitirmos dados diretamente por channel do servidor para o cliente sem que este conteúdo esteja gravado em um ServerProjectFile.

Idealmente o resultado da conversão seria transferido diretamente do documento DOM em memória para o cliente via rede, sem a necessidade de gravá-lo previamente como um arquivo XML. Com isto o cliente poderia ler o arquivo diretamente da rede, marcá-lo como "sujo" e deixar a gravação por conta do usuário, no cliente.

Field Summary

Fields inherited from class csbase.remote.RemoteObjectObservable

observerManager

Fields inherited from interface csbase.remote.XMLConversionServiceInterface

SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
XMLConversionService() Cria uma instância do serviço.

Method Summary

Modifier and Type	Method and Description
protected void	append(File src, OutputStream outputStream) Grava o conteúdo de um arquivo em um stream de saída.
tecgraf.javautils.xml.conversion.XMLConverter.XMLConversionStatus	convertXMLToFile(Object projectId, String[] clientPath, boolean validate, String dtdPrefix)
String	convertXMLToString(Object projectId, String[] clientPath, boolean validate, String dtdPrefix)
protected tecgraf.javautils.xml.conversion.XMLConverter	createConverter(String dtdPrefix) Cria o conversor a ser utilizado.
static void	createService() Cria a instância do serviço.
static XMLConversionService	getInstance() Retorna a instância do serviço.
protected String	getXMLEndMarker() Retorna o marcador da tag final do arquivo XML.
protected boolean	has2Update(Object arg, Object event)
void	initService() Método abstrato de inicialização do serviço.
protected void	postConvert(Object projectId, String[] clientPath, String dtdPrefix, OutputStream outputStream, String xmlData, tecgraf.javautils.xml.conversion.XMLConverter.XMLConversionStatus status) Método com as ações de pós conversão.
protected void	preConvert(Object projectId, String[] clientPath, String dtdPrefix, String xmlData) Executa as ações antes da conversão
void	shutdownService() Método abstrato de término do serviço

Methods inherited from class csbase.server.Service

getBooleanProperty, getDefaultLocale, getDoubleProperty, getExternalPropertyFile, getFormattedString, getFormattedString, getInitializationDependencies, getInstance, getIntProperty, getKey, getLongProperty, getName, getOptionalString, getOptionalString, getOSPropertyPath, getSenderName, getServices, getString, getString, getStringListProperty, getStringProperty, getSystemId, getThreadLocale, getUser, getUserPermission, hasProperty, incrCounter, isActive, isEnabled, isInternalServerRequest, isLoggingNotifications, isPropertyNull, logNotification, setEnabled, setKey, setSystemId, setUserId, setUserLocale

Methods inherited from class csbase.server.ServerRemoteObjectObservable

handleException, handleFatalError

Methods inherited from class csbase.remote.RemoteObjectObservable

addObserver, countObservers, deleteObserver, deleteObserver, deleteObservers, has2update, notifyObservers

Methods inherited from class java.lang.Object

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

Methods inherited from interface csbase.remote.ServiceInterface

getName, isActive

Constructor Detail

XMLConversionService

public XMLConversionService()
                     throws ServerException

Cria uma instância do serviço.

Throws:

ServerException - se houver algum erro na criação do serviço

Method Detail

initService

public void initService()
                 throws ServerException

Método abstrato de inicialização do serviço.

Specified by:

initService in class Service

Throws:

ServerException - em caso de falha

shutdownService

public void shutdownService()
                     throws ServerException

Método abstrato de término do serviço

Specified by:

shutdownService in class Service

Throws:

ServerException - em caso de falha.

has2Update

protected boolean has2Update(Object arg,
                             Object event)

Specified by:

has2Update in class csbase.remote.RemoteObjectObservable

convertXMLToFile

public tecgraf.javautils.xml.conversion.XMLConverter.XMLConversionStatus convertXMLToFile(Object projectId,
                                                                                          String[] clientPath,
                                                                                          boolean validate,
                                                                                          String dtdPrefix)
                                                                                   throws RemoteException

Specified by:

convertXMLToFile in interface csbase.remote.XMLConversionServiceInterface

Throws:

RemoteException

createConverter

protected tecgraf.javautils.xml.conversion.XMLConverter createConverter(String dtdPrefix)
                                                                 throws tecgraf.javautils.xml.conversion.exception.XMLConversionException

Cria o conversor a ser utilizado. Deverá ser sobrescrito por cada subclasse (sub-serviço) de XMLConversionService

Parameters:

dtdPrefix - prefixo DTD

Returns:

o conversor a ser utilizado

Throws:

tecgraf.javautils.xml.conversion.exception.XMLConversionException - em caso de falha de conversão.

postConvert

protected void postConvert(Object projectId,
                           String[] clientPath,
                           String dtdPrefix,
                           OutputStream outputStream,
                           String xmlData,
                           tecgraf.javautils.xml.conversion.XMLConverter.XMLConversionStatus status)

Método com as ações de pós conversão.

Parameters:

projectId - - identificador do projeto

clientPath - - path relativo para o arquivo no projeto

dtdPrefix - - string que será prefixada na declaração do DTD. Pode ser null caso não se deseje um prefixo específico

outputStream - - stream do arquivo convertido

xmlData - - conteúdo do arquivo xml

status - - o status da conversão

preConvert

protected void preConvert(Object projectId,
                          String[] clientPath,
                          String dtdPrefix,
                          String xmlData)

Executa as ações antes da conversão

Parameters:

projectId - - identificador do projeto

clientPath - - path relativo para o arquivo no projeto

dtdPrefix - - string que será prefixada na declaração do DTD. Pode ser null caso não se deseje um prefixo específico

xmlData - - conteúdo do arquivo xml

getXMLEndMarker

protected String getXMLEndMarker()

Retorna o marcador da tag final do arquivo XML. Se não for null é porque o arquivo xml possui, após o fechamento da tag principal, outros conteúdo de interesse para apliações específicas. Se for null, lerá todo o inputStream, que deverá ser apenas XML.

Returns:

marcador da tag final do arquivo XML

convertXMLToString

public String convertXMLToString(Object projectId,
                                 String[] clientPath,
                                 boolean validate,
                                 String dtdPrefix)
                          throws RemoteException

Specified by:

convertXMLToString in interface csbase.remote.XMLConversionServiceInterface

Throws:

RemoteException

append

protected void append(File src,
                      OutputStream outputStream)
               throws tecgraf.javautils.xml.conversion.exception.XMLConversionException

Grava o conteúdo de um arquivo em um stream de saída.

Parameters:

src - origem dos dados

outputStream - stream de saída

Throws:

tecgraf.javautils.xml.conversion.exception.XMLConversionException - em caso de falha de conversão.

getInstance

public static XMLConversionService getInstance()

Retorna a instância do serviço.

Returns:

instância do serviço

createService

public static void createService()
                          throws ServerException

Cria a instância do serviço.

Throws:

ServerException - em caso de falha de criação do serviço.