com.sap.mw.jco

Class JCO.BasicRepository

java.lang.Object
  com.sap.mw.jco.JCO.BasicRepository

All Implemented Interfaces:

IRepository

Direct Known Subclasses:

JCO.Repository

Enclosing class:

JCO

public abstract static class JCO.BasicRepository

extends Object

implements IRepository

The meta data repositories are needed to get the technical description of functions and parameters used for fullfiling of RFC calls. This class covers the implementation of basic repository functionality such as caching and persistence of meta datas. The BasicRepository serves as a base class for more elaborate repositories.
To fetch the meta datas at runtime from backend system use the JCO.Repository class. Note: Since a repository caches the meta datas, it is strongly recommended to create the instance of repository at global scope and use it if possible for all calls to the same SAP backend.
Keep in mind, that the functions and paramters definitions are always the same inside of one cluster of SAP application hosts, but can differ from other cluster. Note: Derived classes have to call super(name) in their constructors in order to initialize the superclass properly

See Also:

JCO.Repository

Field Summary

protected Hashtable	function_cache
protected String	name
protected IRepository	next_repository
protected Hashtable	structure_cache

Constructor Summary

JCO.BasicRepository(String name)
Constructs a new BasicRepository

Method Summary

void	addFunctionInterfaceToCache(IMetaData meta) Adds a function interface to the local cache.
void	addFunctionInterfaceToCache(String key, IMetaData meta) Adds a function interface to the local cache.
void	addStructureDefinitionToCache(IMetaData meta) Adds a structure definition to the local cache.
void	addStructureDefinitionToCache(String key, IMetaData meta) Adds a structure definition to the local cache.
String[]	getCachedFunctionInterfaces() Returns the names of the cached functions as a string array
String[]	getCachedStructureDefinitions() Returns the names of the cached structures as a string array
IMetaData	getFunctionInterface(String function_name) Returns the meta data for the passed function
IFunctionTemplate	getFunctionTemplate(String function_name) Returns the template for the passed function.
String	getName() Returns the repository name
IRepository	getNextRepository() Returns the next repository that will be used if a function or structure could not be found in this one.
IMetaData	getStructureDefinition(String structure_name) Returns the meta data for the passed structure
IMetaData	getTableDefinition(String table_name) Returns the meta data for the passed table
void	load(String filename) Load the repository from the specified file.
void	removeFunctionInterfaceFromCache(String function_name) Removes a function interface from the local cache.
void	removeStructureDefinitionFromCache(String structure_name) Removes a function interface from the local cache.
void	save(String filename) Save the repository to the specified file.
void	setNextRepository(IRepository next) Sets the next repository that will be used if a function or structure could not be found in this one.
protected void	writeHTML(String html_filename) Dumps the whole repository to an HTML file This comes in handy for debugging purposes.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

next_repository

protected IRepository next_repository

function_cache

protected Hashtable function_cache

structure_cache

protected Hashtable structure_cache

Constructor Detail

JCO.BasicRepository

public JCO.BasicRepository(String name)

Constructs a new BasicRepository

Parameters:

name - the name of the repository

Method Detail

getName

public String getName()

Returns the repository name

Specified by:

getName in interface IRepository

Returns:

the name of the repository

getFunctionTemplate

public IFunctionTemplate getFunctionTemplate(String function_name)

Returns the template for the passed function.

Specified by:

getFunctionTemplate in interface IRepository

Parameters:

function_name - the name of the function for which the template is being returned.

Returns:

the template for the function or null if the function template could not be retrieved.

Throws:

JCO.Exception - if another error occurred during the retrieval of the function interface with the group field set appropiately.

getFunctionInterface

public IMetaData getFunctionInterface(String function_name)

Returns the meta data for the passed function

Specified by:

getFunctionInterface in interface IRepository

Parameters:

function_name - the name of the function for which the meta data is being returned

Returns:

the meta data for the function or null if the function couldn't be found

Throws:

JCO.Exception - if an error occurred during the retrieval of the function interface.

getStructureDefinition

public IMetaData getStructureDefinition(String structure_name)

Returns the meta data for the passed structure

Specified by:

getStructureDefinition in interface IRepository

Parameters:

structure_name - the name of the structure for which the meta data is being returned

Returns:

the meta data for the structure or null if the structure couldn't be found

Throws:

JCO.Exception - if an error occurred during the retrieval of the data structure definition.

getTableDefinition

public IMetaData getTableDefinition(String table_name)

Returns the meta data for the passed table

Specified by:

getTableDefinition in interface IRepository

Parameters:

table_name - the name of the table for which the meta data is being returned

Returns:

the meta data for the table or null if not found

Throws:

JCO.Exception - if an error occurred during the retrieval of the table definition.

getNextRepository

public IRepository getNextRepository()

Returns the next repository that will be used if a function or structure could not be found in this one.

Specified by:

getNextRepository in interface IRepository

Returns:

the next repository to use or null if not set

setNextRepository

public void setNextRepository(IRepository next)

Sets the next repository that will be used if a function or structure could not be found in this one.

Specified by:

setNextRepository in interface IRepository

Parameters:

next - the next repository to use. Pass null if none.

addFunctionInterfaceToCache

public void addFunctionInterfaceToCache(IMetaData meta)

Adds a function interface to the local cache. Implementations that do not use a cache just provide an empty method.

Specified by:

addFunctionInterfaceToCache in interface IRepository

Parameters:

meta - the meta data of the interface to add to the cache

addFunctionInterfaceToCache

public void addFunctionInterfaceToCache(String key,
                                        IMetaData meta)

Adds a function interface to the local cache. Implementations that do not use a cache just provide an empty method.

Parameters:

key - the key of the cache entry

meta - the meta data of the interface to add to the cache

addStructureDefinitionToCache

public void addStructureDefinitionToCache(IMetaData meta)

Adds a structure definition to the local cache. Implementations that do not use a cache just provide an empty method.

Specified by:

addStructureDefinitionToCache in interface IRepository

Parameters:

meta - the meta data of a structure to add to the cache

addStructureDefinitionToCache

public void addStructureDefinitionToCache(String key,
                                          IMetaData meta)

Adds a structure definition to the local cache. Implementations that do not use a cache just provide an empty method.

Parameters:

key - the key of the cache entry

meta - the meta data of a structure to add to the cache

removeFunctionInterfaceFromCache

public void removeFunctionInterfaceFromCache(String function_name)

Removes a function interface from the local cache. Implementations that do not use a cache just provide an empty method.

Specified by:

removeFunctionInterfaceFromCache in interface IRepository

Parameters:

function_name - the name of the function to be removed from the cache

removeStructureDefinitionFromCache

public void removeStructureDefinitionFromCache(String structure_name)

Removes a function interface from the local cache. Implementations that do not use a cache just provide an empty method.

Specified by:

removeStructureDefinitionFromCache in interface IRepository

Parameters:

structure_name - the name of the structure to be removed from the cache

getCachedFunctionInterfaces

public String[] getCachedFunctionInterfaces()

Returns the names of the cached functions as a string array

Specified by:

getCachedFunctionInterfaces in interface IRepository

Returns:

a string array of the cached functions or null if the cache is empty

getCachedStructureDefinitions

public String[] getCachedStructureDefinitions()

Returns the names of the cached structures as a string array

Specified by:

getCachedStructureDefinitions in interface IRepository

Returns:

a string array of the cached structures or null if the cache is empty

save

public void save(String filename)
          throws IOException

Save the repository to the specified file.

Specified by:

save in interface IRepository

Parameters:

filename - the file to save the repository to.

Throws:

IOException - in case of an I/O error.

load

public void load(String filename)
          throws IOException

Load the repository from the specified file.

Specified by:

load in interface IRepository

Parameters:

filename - the file to load the repository from.

Throws:

IOException - in case of an I/O error.

writeHTML

protected void writeHTML(String html_filename)

Dumps the whole repository to an HTML file This comes in handy for debugging purposes.

Parameters:

html_filename - the HTML file