com.saperion.ws

Class SaWsConfigurationService

java.lang.Object

com.saperion.ws.AbstractService

com.saperion.ws.SaWsConfigurationService

public class SaWsConfigurationService
extends AbstractService

This class wraps all methods of the SaClassicConnector. It parses the information, which is fetched from the server to classes usable for web services. JAX-B requires classes to be JavaBeans, because it uses the set/get-Methods. You need a token for calling the methods to perform searches and modifications. For getting a token the logon method has to be called. If the thread is timed out on the backend or if you aren't logged in you will get an exception.

Author:

Daniel Manzke(dam)

Field Summary

Fields inherited from class com.saperion.ws.AbstractService

configured

Constructor Summary

Constructors

Constructor and Description
SaWsConfigurationService() Constructor.

Method Summary

Modifier and Type	Method and Description
List<SaWsProperty>	getConfiguration(int token, String section) Reads the configuration properties from the backend system.
List<SaWsFieldDescription>	getDefinition(int token, String definition) Reads the DDC definition of one database with the given name.
String[]	getDefinitions(int token) Reads the registered DDC names from the repository.

Methods inherited from class com.saperion.ws.AbstractService

addToRequest, getConnection, getSession, isConfigured

Methods inherited from class java.lang.Object

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

Constructor Detail

SaWsConfigurationService

public SaWsConfigurationService()

Constructor.

Method Detail

getDefinitions

public String[] getDefinitions(int token)
                        throws SaWsAuthenticationException,
                               SaWsRepositoryException,
                               SaWsException

Reads the registered DDC names from the repository.

Parameters:

token - to identify the session

Returns:

Array of DDC names

Throws:

SaWsAuthenticationException - if an authentication error occurs.

SaWsRepositoryException - if a repository error occurs.

SaWsException

See Also:

SaClassicConnector.getDefinitions()

getDefinition

public List<SaWsFieldDescription> getDefinition(int token,
                                                String definition)
                                         throws SaWsAuthenticationException,
                                                SaWsRepositoryException,
                                                SaWsException

Reads the DDC definition of one database with the given name.

Parameters:

token - to identify the session

definition - Database name

Returns:

Array of field definitions

Throws:

SaWsAuthenticationException - if an authentication error occurs.

SaWsRepositoryException - if a repository error occurs.

SaWsException

See Also:

SaClassicConnector.getDBDefinition(java.lang.String)

getConfiguration

public List<SaWsProperty> getConfiguration(int token,
                                           String section)
                                    throws SaWsRepositoryException,
                                           SaWsAuthenticationException,
                                           SaWsException

Reads the configuration properties from the backend system.

Parameters:

token - to identify the session

section - Section in program.ini

Returns:

Configuration properties

Throws:

SaWsAuthenticationException - if an authentication error occurs.

SaWsRepositoryException - if a repository error occurs.

SaWsException

See Also:

SaClassicConnector.getConfiguration(java.lang.String)