|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JCoRepository
JCo metadata repositories are needed to get the technical description of functions and parameters used for fulfilling RFC calls.
This interface covers the implementation of basic repository functionality such as
caching and the persistence of metadata.
The JCoCustomRepository serves as a base interface for more elaborate repositories.
To fetch the metadata at runtime from a back-end system use the JCoRepository instance
returned by a JCoDestination.
Keep in mind, that the functions and parameter definitions are always the same inside of one
cluster of SAP application server hosts, but can differ from other clusters.
JCoCustomRepository
Method Summary | |
---|---|
void |
clear()
Clear allows to empty both the function template cache as well as the record metadata cache completely. All metadata will be looked up again in the original source, which is generally much more expensive than looking it up in the cache. |
java.lang.String[] |
getCachedClassMetaDataNames()
Returns the names of the cached classes as a string array. |
java.lang.String[] |
getCachedFunctionTemplateNames()
Returns the names of the cached functions as a string array. |
java.lang.String[] |
getCachedRecordMetaDataNames()
Returns the names of the cached structures as a string array. |
JCoClassMetaData |
getClassMetaData(java.lang.String className)
Returns the metadata for the passed class/interface name. |
JCoFunction |
getFunction(java.lang.String functionName)
Returns a JCoFunction with initial parameters for the passed function name. |
JCoListMetaData |
getFunctionInterface(java.lang.String functionName)
Returns the metadata for the passed function. |
JCoFunctionTemplate |
getFunctionTemplate(java.lang.String functionName)
Returns the template for the passed function. |
JCoRepositoryMonitor |
getMonitor()
Returns a newly created or available monitor instance for the repository. |
java.lang.String |
getName()
Returns the repository name. |
JCoRecordMetaData |
getRecordMetaData(java.lang.String recordName)
Returns the metadata for the passed structure/table name. |
JCoRequest |
getRequest(java.lang.String functionName)
Returns a JCoRequest with initial parameters for the passed function name. |
JCoRecordMetaData |
getStructureDefinition(java.lang.String structureName)
Returns the metadata for the passed structure/table name. |
boolean |
isUnicode()
Returns whether the repository contains both Unicode and non-Unicode metadata. Repositories containing metadata for SAP systems running on non-Unicode codepages cannot contain metadata for unicode structures. |
void |
load(java.io.Reader reader)
Loads the repository from the given reader. Note that the existing cache is cleared completely before reading. |
void |
removeClassMetaDataFromCache(java.lang.String className)
Removes a class metadata instance from the local cache. |
void |
removeFunctionTemplateFromCache(java.lang.String functionName)
Removes a function template from the local cache. |
void |
removeRecordMetaDataFromCache(java.lang.String recordName)
Removes a record metadata from the local cache. |
void |
save(java.io.Writer writer)
Saves this repository using the given writer. This method does not close the given writer. |
Method Detail |
---|
java.lang.String getName()
JCoFunctionTemplate getFunctionTemplate(java.lang.String functionName) throws JCoException
functionName
- the name of the function for which the template
is being returned
JCoException
- if another error occurred during the retrieval
of the function interface with the group field set appropriatelyJCoFunction getFunction(java.lang.String functionName) throws JCoException
functionName
- the name of the function for which the JCoFunction
is being returned
JCoException
- if another error occurred during the retrieval
of the function interface with the group field set appropriatelyJCoRequest getRequest(java.lang.String functionName) throws JCoException
functionName
- the name of the function for which the request
is being returned.
JCoException
- if another error occurred during the retrieval
of the function interface with the group field set appropriatelyJCoListMetaData getFunctionInterface(java.lang.String functionName) throws JCoException
functionName
- the name of the function for which the metadata
is being returned
JCoException
- if an error occurred during the retrieval
of the function interfaceJCoRecordMetaData getRecordMetaData(java.lang.String recordName) throws JCoException
recordName
- the name of the structure or table for which the metadata
is being returned
JCoException
- if an error occurred during the retrieval
of the data structure definitionJCoRecordMetaData getStructureDefinition(java.lang.String structureName) throws JCoException
structureName
- the name of the structure or table for which the metadata
is being returned
JCoException
- if an error occurred during the retrieval
of the data structure definitionJCoClassMetaData getClassMetaData(java.lang.String className) throws JCoException
className
- the name of the class or interface for which the metadata
is being returned
JCoException
- if an error occurred during the retrieval
of the class metadata definitionvoid removeFunctionTemplateFromCache(java.lang.String functionName)
functionName
- the name of the function to be removed from the cachevoid removeRecordMetaDataFromCache(java.lang.String recordName)
recordName
- the name of the structure to be removed from the cachevoid removeClassMetaDataFromCache(java.lang.String className)
className
- the name of the class to be removed from the cachejava.lang.String[] getCachedFunctionTemplateNames()
java.lang.String[] getCachedRecordMetaDataNames()
java.lang.String[] getCachedClassMetaDataNames()
boolean isUnicode()
void clear()
JCoRepositoryMonitor getMonitor()
void load(java.io.Reader reader) throws java.io.IOException
reader
- the reader to be used for loading this repository
java.io.IOException
- if an I/O error occurs
JCoRuntimeException
- with key JCO_ERROR_REPOSITORY_SERIALIZATION if the read data
is syntactically or semantically incorrectvoid save(java.io.Writer writer) throws java.io.IOException
writer
- the writer used to save this repository
java.io.IOException
- if an I/O error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |