|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sap.conn.jco.JCo
public abstract class JCo
The main factory class of JCo. With the methods in this class it is possible to create the instances of JCo classes, e.g. the data containers such as implementations of JCoStructure, JCoTable or JCoParameterList. Further you can create instances of metadata for implementing your own repository if you need to do so.
Method Summary | |
---|---|
static void |
addTraceListener(JCoTraceListener listener)
Adds a trace listener, that receives all trace events of JCo |
static JCoAbapObject |
createAbapObject(JCoClassMetaData classMetaData,
java.util.Map<java.lang.String,java.lang.Object> initialValues)
This is a constructor for an instance of an ABAP class. |
static JCoBackgroundUnitAttributes |
createBackgroundUnitAttributes()
Creates an empty instance of function/request unit attributes. |
static JCoClassMetaData |
createClassMetaData(JCoClassMetaData metaData)
Returns a newly created instance of JCoClassMetaData, which is initially a copy of the passed JCoClassMetaData. |
static JCoClassMetaData |
createClassMetaData(java.lang.String name)
Returns a newly created and empty instance of JCoClassMetaData with the passed initial capacity for new field information. |
static JCoClassMetaData |
createClassMetaData(java.lang.String name,
java.lang.String[] parentClasses,
java.lang.String[] implementedInterfaces,
int capacity)
Returns a newly created and empty instance of JCoClassMetaData with the passed initial capacity for new field information. |
static JCoCustomRepository |
createCustomRepository(java.lang.String name)
Returns a custom repository, which allows to add custom defined function templates and record metadata definitions |
static JCoFunctionTemplate |
createFunctionTemplate(java.lang.String name,
JCoListMetaData imports,
JCoListMetaData exports,
JCoListMetaData changing,
JCoListMetaData tables,
AbapException[] exceptions)
This factory method allows to create a JCoFunctionTemplate that can be used in later function module executions. |
static JCoFunctionTemplate |
createFunctionTemplate(java.lang.String name,
JCoListMetaData imports,
JCoListMetaData exports,
JCoListMetaData changing,
JCoListMetaData tables,
AbapException[] exceptions,
boolean supportsASXML)
This factory method allows to create a JCoFunctionTemplate that can be used in later function module executions. |
static JCoFunctionUnit |
createFunctionUnit(JCoBackgroundUnitAttributes unitAttributes)
Creates a new (empty) unit of functions, which is used for bgRFC commuication in the function model. |
static JCoFunctionUnit |
createFunctionUnit(java.lang.String unitID,
JCoBackgroundUnitAttributes unitAttributes)
Creates a new (empty) unit of functions, which is used for bgRFC commuication in the function model. |
static JCoListMetaData |
createListMetaData(JCoListMetaData metaData)
Returns a newly created instance of JCoListMetaData, which is initially a copy of the passed JCoListMetaData. |
static JCoListMetaData |
createListMetaData(java.lang.String name)
Returns a newly created and empty instance of JCoListMetaData. |
static JCoListMetaData |
createListMetaData(java.lang.String name,
int capacity)
Returns a newly created and empty instance of JCoListMetaData with the passed initial capacity for new field information. |
static JCoRecordMetaData |
createRecordMetaData(JCoRecordMetaData metaData)
Returns a newly created instance of JCoRecordMetaData, which is initially a copy of the passed JCoRecordMetaData. |
static JCoRecordMetaData |
createRecordMetaData(java.lang.String name)
Returns a newly created and empty instance of JCoRecordMetaData. |
static JCoRecordMetaData |
createRecordMetaData(java.lang.String name,
int capacity)
Returns a newly created and empty instance of JCoRecordMetaData with the passed initial capacity for new field information. |
static JCoRequestUnit |
createRequestUnit(JCoBackgroundUnitAttributes unitAttributes)
Creates a new (empty) unit of requests, which is used for bgRFC communication in the request/response model. |
static JCoRequestUnit |
createRequestUnit(java.lang.String unitID,
JCoBackgroundUnitAttributes unitAttributes)
Creates a new (empty) unit of requests, which is used for bgRFC commuication in the request/response model. |
static JCoStructure |
createStructure(JCoRecordMetaData metaData)
Returns a newly created instance of JCoStructure with the passed metadata information. |
static JCoStructure |
createStructure(JCoTable table,
int row)
Returns a newly created instance of JCoStructure with the metadata used for the given table instance. |
static JCoTable |
createTable(JCoRecordMetaData metaData)
Returns a newly created instance of JCoTable with the passed metadata information. |
static JCoThroughput |
createThroughput()
Returns a newly created instance of JCoThroughput. |
static JCoUnitIdentifier |
createUnitIdentifier(java.lang.String unitID,
JCoUnitIdentifier.Type unitType)
Creates a new unit identifier. |
static JCoConnectionMonitor |
getConnectionMonitor()
Returns the connection monitor for all currently available connections. |
static java.util.List<java.lang.String> |
getCustomDestinationIDs(java.lang.String destinationID)
Creates and returns a list with IDs of all custom destinations created by the destination with the given destinationID. |
static java.util.List<java.lang.String> |
getDestinationIDs()
Creates and returns a list containing IDs of all available cached destinations. |
static JCoDestinationManager |
getDestinationManager()
Deprecated. Reserved for internal use - visibility might be reduced in future versions without further notice. Use the static methods in JCoDestinationManager instead. |
static JCoDestinationMonitor |
getDestinationMonitor(java.lang.String destinationID)
Retrieves a monitoring object for a specific destination identified by the given ID. |
static java.lang.String |
getMiddlewareProperty(java.lang.String key)
Returns the current value for the given middleware property or null, if there is no value set. |
static java.lang.String |
getProperty(java.lang.String key)
Returns the current value for the given JCo property or null, if there is no value set. |
static JCoRepository |
getRepository(java.lang.String repositoryID)
Returns the repository instance corresponding to the given repository ID or null if the repository isn't available |
static java.lang.String |
getRepositoryDestinationID(java.lang.String destinationID)
Returns the destination ID used by repository instances internally. |
static JCoDestinationMonitor |
getRepositoryDestinationMonitor(java.lang.String destinationID)
Retrieves a monitoring object for a specific repository destination of the destination identified by the given ID. |
static java.util.List<java.lang.String> |
getRepositoryIDs()
Returns a list containing IDs of all repository instances that are kept internally. |
static java.util.List<java.lang.String> |
getServerIDs()
Returns a list containing IDs of all available server instances. |
static JCoServerMonitor |
getServerMonitor(java.lang.String serverID)
Returns a server monitor for the given server ID |
static int |
getTraceLevel()
Returns the current trace level. |
static java.lang.String |
getTracePath()
Returns the current trace path. |
static java.lang.String |
getVersion()
Returns the version of the JCo implementation |
static JCoRepositoryQueryResult |
queryMetaDataSet(JCoRepository repository,
java.util.List<java.lang.String> functions,
java.util.List<java.lang.String> types,
java.util.List<java.lang.String> classes)
Queries the meta data for function, type and class lists. |
static void |
removeTraceListener(JCoTraceListener listener)
Removes the given trace listener from the list of JCoTraceListeners |
static void |
setMiddlewareProperty(java.lang.String key,
java.lang.String value)
Sets a value for the given middleware property. |
static void |
setProperty(java.lang.String key,
java.lang.String value)
Sets a value for the given JCo property. |
static void |
setTrace(int level,
java.lang.String path)
Turns on the JCo trace. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static java.lang.String getVersion()
public static JCoDestinationManager getDestinationManager()
JCoDestinationManager
instead.
public static JCoCustomRepository createCustomRepository(java.lang.String name)
name
- The name of the repository to create.
public static JCoRecordMetaData createRecordMetaData(java.lang.String name)
name
- The name of the record metadata.
public static JCoRecordMetaData createRecordMetaData(java.lang.String name, int capacity)
name
- The name of the record metadata.capacity
- The initial capacity for this metadata object.
public static JCoRecordMetaData createRecordMetaData(JCoRecordMetaData metaData)
metaData
- the JCoRecordMetaData object to copy from
JCoMetaData.setName(String)
public static JCoListMetaData createListMetaData(java.lang.String name)
name
- The name of the list metadata.
public static JCoListMetaData createListMetaData(java.lang.String name, int capacity)
name
- The name of the list metadata.capacity
- The initial capacity for this metadata object.
public static JCoListMetaData createListMetaData(JCoListMetaData metaData)
metaData
- the JCoListMetaData object to copy from
public static JCoClassMetaData createClassMetaData(java.lang.String name, java.lang.String[] parentClasses, java.lang.String[] implementedInterfaces, int capacity)
name
- class type nameparentClasses
- parent classes of the class type being createdimplementedInterfaces
- interfaces implemented by the class type being createdcapacity
- the number of preallocated field expected for that class metadata object
public static JCoClassMetaData createClassMetaData(java.lang.String name)
name
- class type name
public static JCoClassMetaData createClassMetaData(JCoClassMetaData metaData)
metaData
- the JCoClassMetaData object to copy from
public static JCoFunctionTemplate createFunctionTemplate(java.lang.String name, JCoListMetaData imports, JCoListMetaData exports, JCoListMetaData changing, JCoListMetaData tables, AbapException[] exceptions)
name
- the name of the function module which is represented by the function template definitionimports
- the metadata for all import parameters of the represented function moduleexports
- the metadata for all export parameters of the represented function modulechanging
- the metadata for all changing parameters of the represented function moduletables
- the metadata for all table parameters of the represented function moduleexceptions
- array of AbapExceptions, that belong to the represented function module
java.lang.IllegalArgumentException
- in case a metadata object passed as parameter is not locked.public static JCoFunctionTemplate createFunctionTemplate(java.lang.String name, JCoListMetaData imports, JCoListMetaData exports, JCoListMetaData changing, JCoListMetaData tables, AbapException[] exceptions, boolean supportsASXML)
name
- the name of the function module which is represented by the function template definitionimports
- the metadata for all import parameters of the represented function moduleexports
- the metadata for all export parameters of the represented function modulechanging
- the metadata for all changing parameters of the represented function moduletables
- the metadata for all table parameters of the represented function moduleexceptions
- array of AbapExceptions, that belong to the represented function modulesupportsASXML
- flag indicating whether this function module supports the ASXML semantics for serialization in the RFC protocol
java.lang.IllegalArgumentException
- in case a metadata object passed as parameter is not locked.public static JCoStructure createStructure(JCoRecordMetaData metaData)
metaData
- the metadata instance.
java.lang.IllegalArgumentException
- if metaData is null or is not lockedpublic static JCoStructure createStructure(JCoTable table, int row)
table
- the table is being used as template for the structure.row
- the table line index used to copy the values.
java.lang.IllegalArgumentException
- row is out of bounds or table is nullpublic static JCoTable createTable(JCoRecordMetaData metaData)
metaData
- the metadata instance.
java.lang.IllegalArgumentException
- if metaData is null or is not lockedpublic static JCoAbapObject createAbapObject(JCoClassMetaData classMetaData, java.util.Map<java.lang.String,java.lang.Object> initialValues)
setValue()
methods.
classMetaData
- The metadata describing the ABAP object.initialValues
- A map whose entries will be used as initial values for the instance. Unknown fields will be
ignored.
ConversionException
- if one of the values could not be converted into the corresponding attribute typepublic static JCoFunctionUnit createFunctionUnit(java.lang.String unitID, JCoBackgroundUnitAttributes unitAttributes)
unitID
- ID to be assigned to the function unit
public static JCoFunctionUnit createFunctionUnit(JCoBackgroundUnitAttributes unitAttributes)
public static JCoRequestUnit createRequestUnit(java.lang.String unitID, JCoBackgroundUnitAttributes unitAttributes)
unitID
- ID to be assigned to the request unit
public static JCoRequestUnit createRequestUnit(JCoBackgroundUnitAttributes unitAttributes)
public static JCoBackgroundUnitAttributes createBackgroundUnitAttributes()
public static JCoUnitIdentifier createUnitIdentifier(java.lang.String unitID, JCoUnitIdentifier.Type unitType)
public static java.util.List<java.lang.String> getRepositoryIDs()
public static JCoRepository getRepository(java.lang.String repositoryID) throws JCoRuntimeException
repositoryID
- ID of the requested repository
JCoRuntimeException
- if an internal exception occurs, e.g. repositoryID is nullpublic static java.util.List<java.lang.String> getDestinationIDs()
public static java.util.List<java.lang.String> getCustomDestinationIDs(java.lang.String destinationID) throws JCoRuntimeException
destinationID
- ID of the destination used for the creation of the custom destinations
JCoRuntimeException
public static java.lang.String getRepositoryDestinationID(java.lang.String destinationID) throws JCoRuntimeException
destinationID
- of the destination
JCoRuntimeException
- is thrown if destination id null or the destination id does not existspublic static JCoDestinationMonitor getDestinationMonitor(java.lang.String destinationID) throws JCoRuntimeException
destinationID
- the unique destination ID for which the monitor should be returned
JCoRuntimeException
- in case of issues while getting and creating the destination monitorpublic static JCoDestinationMonitor getRepositoryDestinationMonitor(java.lang.String destinationID) throws JCoRuntimeException
destinationID
- the unique destination ID for which the monitor for the repository destination should be returned
JCoRuntimeException
- in case of issues while getting and creating the destination monitorpublic static java.util.List<java.lang.String> getServerIDs()
public static JCoServerMonitor getServerMonitor(java.lang.String serverID) throws JCoRuntimeException
serverID
- the server ID for which the monitor should be returned
JCoRuntimeException
- if an unexpected situation occurs while creating the monitor
java.lang.UnsupportedOperationException
- if server monitoring is not supported in the current environmentpublic static JCoConnectionMonitor getConnectionMonitor()
JCoRuntimeException
- if an unexpected situation occurs while creating the monitor
java.lang.UnsupportedOperationException
- if the monitor is not supported in the current environmentpublic static JCoThroughput createThroughput()
public static java.lang.String getMiddlewareProperty(java.lang.String key)
key
- the name of the property for which you want to get the value
public static java.lang.String getProperty(java.lang.String key)
key
- the name of the property for which you want to get the value
public static void setMiddlewareProperty(java.lang.String key, java.lang.String value)
Property name | Description |
---|---|
jco.middleware.max_startup_delay | The maximum time in seconds between restart tries for a JCoServer. Serves as default value, if there is no server specific one. Values below 60 seconds are not allowed. (Default: 3600) |
jco.middleware.wait_for_request_time | Sets the trace level for JCo. Alternative to JCo.setTrace() . Find details there. |
jco.middleware.snc_lib | The location of the SNC library. Serves as default value, if there is no server or destination specific configuration. (Default: "") |
jrfc.client_connect_timeout | The timeout for a logon try after having established the technical client connection to an ABAP server. Provide it in seconds (Default: 60s) |
key
- the name of the property for which you want to set the valuevalue
- the new value, that the property should get
JCoRuntimeException
- if the value is not fitting to the propertypublic static void setProperty(java.lang.String key, java.lang.String value)
Property name | Description |
---|---|
jco.trace_path | Sets the location of the path for JCo trace files. Alternative to JCo.setTrace() . Find details there. |
jco.trace_level | Sets the trace level for JCo. Alternative to JCo.setTrace() . Find details there. |
jco.jarm | If set to 1, turns on jarm performance monitoring. In that case the jarm libraries need to be in the classpath. (Default: 0) |
jco.jdsr | If set to 1, turns on DSR. In that case the jdsr libraries need to be in the classpath. (Default: 0) |
jco.jdsr.comp_name | The component name to use when creating DSR records. (Default: SAP Java Connector) |
jco.session_timeout | The idle timeout for JCo session contexts in minutes. (Default: 10) |
jco.session_timeout.check_interval | The time interval for checking whether JCo session contexts have been expired in minutes. (Default: 5) |
jco.cpic_maxconv | The maximum number of connections allowed by the CPIC layer. (Default: runtime environment dependent, min. 202) |
jco.cpic_keep_alive_period | The time a server connection has been idle, after which a keep alive ping event is sent, in seconds (Default: 300) |
jco.cpic_keep_alive_timeout | Timeout for a ping in ms. After that time a connection is considered as broken. (Default: 10) |
cpic.trace | The trace level for the CPIC layer. The valid value range is from 0 (trace is off) to 3 (most verbose trace) (Default: 0) |
jrfc.trace | If set to 1, RFC trace is turned on for all connections within JCo. (Default: 0) |
jco.delta_management | If set to 0, delta management in RFC protocol is turned off in general. (Default: 1) |
jco.use_repository_roundtrip_optimization | If set to 1, the JCo repository tries to use the function module for roundtrip optimization for metadata lookups. (Default: 0) See SAP note 1456826 regarding back-end prerequisites. |
Note: The property jco.session_timeout
specifies the timeout period since the last access to a
session context after which the registered SessionReferenceProvider
instance will be regularly called
for checking, if the associated JCo session is still alive or not. Only if the method
SessionReferenceProvider.isSessionAlive(sessionID)
returns false
for the specified sessionID,
the associated JCo session context will be released, which means that also all still running RFC requests belonging
to this context will be immediately canceled.
Most of the above properties can also be passed as a Java system property with the -D argument when starting the JVM.
These are: jco.trace_path
, jco.trace_level
, jco.jarm
, jco.jdsr
,
jco.session_timeout
, jco.session_timeout.check_interval
, jco.cpic_maxconv
,
jco.cpic_keep_alive_period
, jco.cpic_keep_alive_timeout
, cpic.trace
,
jrfc.trace
, jco.delta_management
and jco.use_repository_roundtrip_optimization
.
Some other properties can only exclusively be passed as a Java system property with the -D argument when starting the JVM.
That means they cannot be modified during runtime after the JCo framework initialization anymore. This applies to the
following properties listed below:
Property name | Description |
---|---|
jco.allow_non_abap_partner | If set to 1 the RFC extern-to-extern communication is allowed. (Default: 0) For further details see SAP note 1877907 regarding the SAP JCo standalone environment and SAP note 1729203 regarding the SAP NetWeaver AS Java environment. |
jco.program_name | The RFC caller program name. (Default: SAPJCo<VersionNumber> [e.g. SAPJCo30 ]) |
Caution: For security reasons SAP discourages to run extern-to-extern RFC communication scenarios. External or registered RFC server programs are not able to check and authenticate incoming RFC requests from external non-ABAP programs with regard to the pure RFC protocol data. Each of such external RFC requests must be regarded as insecure. It is highly recommended to secure such RFC communications with SNC (Secure Network Communication).
key
- the name of the property for which a value should be setvalue
- the new value for the property
JCoRuntimeException
- if the value is not fitting to the propertypublic static void addTraceListener(JCoTraceListener listener)
listener
- An instance of JCoTraceListener, that shall be added to the listener listpublic static void removeTraceListener(JCoTraceListener listener)
listener
- An instance of JCoTraceListener, that shall be removed from the listener listpublic static void setTrace(int level, java.lang.String path)
null
, stdout
, stderr
or
an existing path are allowed.
If path is equals null
or stdout
or stderr
JCo will trace out to the standard output (error) stream. If at least one
JCoTraceListener
is registered, the trace output will be sent
to the listener only. To redirect the JCo trace into a file, the path value
has to be set to an existing directory.
level
- [0 .. 10]path
- null
, stdout
, stderr
or an existing pathpublic static int getTraceLevel()
setTrace(int, String)
public static java.lang.String getTracePath()
setTrace(int, String)
public static JCoRepositoryQueryResult queryMetaDataSet(JCoRepository repository, java.util.List<java.lang.String> functions, java.util.List<java.lang.String> types, java.util.List<java.lang.String> classes) throws JCoException
repository
- repository, that will be used for the query. Only repositories connected to the ABAP system are allowedfunctions
- list of functions to be queried or nulltypes
- list of types to be queried or nullclasses
- list of classes to be queried or null
JCoException
- if a communication error will happen an JCoException with the key JCO_ERROR_COMMUNICATION will be thrown.
If the specified repository instance is not connected to an ABAP system a JCoException with key JCO_ERROR_ILLEGAL_ARGUMENT will be thrown.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |