All Classes and Interfaces
Class
Description
This class represents an ABAP class exception.
The Mode enumeration describes how class exceptions should be handled by
a server system.
A convenience class on top of JCoException that reports exceptions, which occurred
in an SAP system, while processing a function module.
The About class allows getting information about JCo.
Account
interface provides information about particular account.AuthenticationHeader
provides header name and value which can be
used for authentication with other remote systems.The AuthenticationHeaderProvider provided methods for generation of
authentication headers for access to on-premise systems and applications
deployed on the same SCP landscape.
Web applications can access AuthenticationHeaderProvider via JNDI lookup or resource injection.
Web applications can access AuthenticationHeaderProvider via JNDI lookup or resource injection.
An interface used by LoginContextFactory to access
login context provider implementations.
Provides commonly used constants during Destination validation.
ConnectionInfo
contains the connection id and connection counter
related to the established connection.ConnectivityConfiguration
provides read only access to
destination properties.Socket factory capable of creating Sockets to on premise systems.
A ConversionException will be thrown, if a field in a JCoRecord cannot
store a value passed to this record by a setValue call.
DestinationConfiguration
interface provides read only access to
destination properties.Provides functionality to validate a destination configuration.
This class is a utility class to simplify connecting to the SAP Cloud Platform document service.
See the javadoc in
EcmFactory
.This annotation needs to be set at the implementing classes of
Please make sure, to only specify over all your annotations each
JCoServerFunctionHandler
in order to register their implementation at
the server instance during webapp startup.Please make sure, to only specify over all your annotations each
functionName
only once.Provides constants which are HTTP Destination specific.
InvalidTenantException is a runtime exception which is thrown when specified tenant does not exist or is not assigned
to the current application.
The main factory class of JCo.
The interface comprises public methods for access to ABAP object members.
Deprecated.
Will be removed in a future release without further notice.
Deprecated.
Will be removed in a future release without further notice.
Encapsulates a number of attributes of a connection, such as
codepage information, system information of the communication partner,
and other useful data.
Unit Attributes describing some properties of a processed bgRFC unit in the backend.
Encapsulates the metadata of ABAP classes.
An enumeration of the possible or relevant attribute types.
This class provides some details for an RFC connection.
Connection monitor provides descriptive details for all opened connections.
The JCoContext class allows the execution of stateful function call sequences with JCo.
A JCoCustomDestination is a customizable destination which allows to set specific user logon data
and SNC configuration parameters.
UserData allows to change the user logon data for a JCoCustomDestination.
JCoCustomRepository
is designed to be used for static/custom metadata.Enumeration that describes all modes to control the remote queries of a custom repository.
JCoDestination identifies a physical destination of a function call.
The JCoDestinationManager creates and manages the destinations used by JCo applications.
The destination monitor provides runtime details about a destination.
General JCo exception object.
Encapsulates the extended metadata of a single field of either a parameter list,
a structure, or a table.
Class to represent a data field in a record (i.e.
Encapsulates an iterator for the fields of a record.
Class that represents a function.
Encapsulates all metadata of a function and its import, changing, export
and table parameters as well as the exception list.
The interface comprises public methods to work with function unit.
Defines possible function unit states.
Encapsulates the metadata of either a parameter list, a request, or a response.
Encapsulates the metadata of JCo data containers.
Class to represent a data field in a parameter list.
Encapsulates an iterator for the fields of a parameter list.
A class that encapsulates a parameter list used to pass on data
to a function.
Base interface for all data containers used throughout the JCo framework.
Class to represent a data field in a structure or table.
Encapsulates an iterator for the fields of a structure or table.
Encapsulates the metadata of either a structure or a table.
This interface comprises all the methods an object representing a remote context of a (failed)
RFC connection is required to implement.
JCo metadata repositories are needed to get the technical description
of functions and parameters used for fulfilling RFC calls.
Repository monitor provides some additional details about the repository.
JCoRepositoryResult describes the result of the repository query.
A JCoRequest is a special view on a JCoFunction and is used in the
Request/Response model of JCo function calls.
The interface comprises public methods to work with request unit.
A JCoResponse is a special view on a JCoFunction and is used in the
Request/Response model of JCo function calls.
Basic JCo exception for JCo runtime exceptions.
The JCoServer interface provides access to the public APIs in the JCo server implementation.
Authentication data sent by the caller system.
Deprecated.
Will be removed in a future release without further notice.
Type of the
JCoServerAuthenticationData
object.This exception is used by a JCo server's security handler for notifying a caller system,
that the user, who initiated a remote function call, does not have access to the corresponding
JCoServer
instance.Deprecated.
Will be removed in a future release without further notice.
This exception is used by a JCo server's security handler for notifying a caller system,
that the user, who initiated a remote function call, does not have the authorization for
invoking this function module in the corresponding
JCoServer
instance.Describes all types of requests a server can receive via RFC from the ABAP client.
JCoServerContext provides additional information for the remote call.
JCoServerContextInfo provides additional information of the remote system and the context of the request.
Listener interface for the errors occurred inside of the JCoServer.
Listener interface for the exceptions occurred inside of the JCoServer in the JCo runtime.
Factory for creating the server instance used by JCo applications in the CF Environment.
Interface for the function handler.
The security handler will be called for authenticating user credentials and for
checking the permissions of the user, who initiated a remote function call.
JCoServerState reflects the possible states of a JCoServer.
JCo server state change listener interface.
This interface defines methods to handle transactions being received from an SAP system.
This interface defines methods to handle a function unit received by a
JCoServer
.Interface providing information about an authenticated user in the context of a
JCoServer
instance.JCoStructure is for data containers that need a certain layout in memory.
Interface that describes internal tables used in the parameter lists
of function modules.
JCo Throughput interface.
The implementation of this interface stores performance data.
The implementation of this interface stores performance data.
JCo trace listener interface.
Function unit identifier is a unique identifier for a function or request unit for bgRFC.
BgRFC unit types.
Thrown in case the keystore is changed in the storage and it cannot be load again.
Thrown if a keystore with the specified name doesn't exist.
Interface of the keystore service that provides read-only access to the available keystores in SAP Cloud Platform.
Thrown if a problem with the keystore access occurs.
Provides constants which are Ldap Destination specific.
Socket factory capable of creating sockets to LDAP on premise systems.
The factory of JAAS login contexts can be used to instantiate
login contexts with the correct class loading environment for
the configured login modules.
Provides constants which are Mail Destination specific.
Indicates that methods having this annotation must be implemented in the future.
Exception for errors caused by unauthorized access.
An abstract class used to access OAuthAuthorization implementation.
Performs the protected resource access check by retrieving from the
Authorization Server the scopes associated with the given Access Token, and
checks the Token validity.
Exception class which is used in case of communication errors between the
OAuth Recourse Server and the OAuth Authorization Server when authorization is checked.
A special OutOfMemoryError indicating that a JNI call terminated
with a return code showing that a memory allocation failed.
This enumeration provides the codes of a password check operation.
This interface provides the ability to store passwords in a central storage.
This exception is thrown in case there are errors while trying to set, get or delete
a password via Password storage API.
Exception class which is used in case of communication errors with the user
store during search, read or write operations.
This exception signals that an attempt to create a new repository failed, as the requested
repository already exists.
This exception signals that a repository could not be deleted because it still contains content.
This class defines various repository options necessary to create a new repository.
Specifies the repository visibility level.
This exception signals that an attempt to create a new repository failed, as the respective quota
of repositories is exceeded.
Provides constants which are RFC Destination specific.
SapPassportHeader
provides header name and value which can be
used to forward SAP statistics to other remote systems.SapPassportHeaderProvider
provides an updated SAP-PASSPORT that
should be forwarded to the new connection.This annotation needs to be set at the implementing classes of
Please make sure, to only specify one class with this annotation.
JCoServerSecurityHandler
in order to register their implementation at
the server instance during webapp startup.Please make sure, to only specify one class with this annotation.
Generic exception encapsulating other root causes.
Tenant
interface provides information about particular tenant.TenantAlreadySetException is a runtime exception which is thrown when another tenant is already assigned to the
current thread.
TenantContext
interface provides information about the tenant which is associated with the current
Thread
.TenantUnavailableException is a runtime exception which is thrown when the tenant context is unavailable.
This annotation needs to be set at the implementing classes of
Please make sure, to only specify one class with this annotation.
JCoServerTIDHandler
in order to register their implementation at the
server instance during webapp startup.Please make sure, to only specify one class with this annotation.
Base class for all declared exceptions thrown by the UM bundle.
This annotation needs to be set at the implementing classes of
Please make sure, to only specify one class with this annotation.
JCoServerUnitIDHandler
in order to register their implementation at
the server instance during webapp startup.Please make sure, to only specify one class with this annotation.
Exception which is throw if an attribute should be read which is not
supported by the user store.
This interface provides read access to user data and is an extension of
Principal
.The interface represents abstraction over a user general attribute, such as
an e-mail address.
A common accessor to user management API implementation.
This interface represents the service interface which provides read access to
a user implementation.
Two possible ways to search for user attribute values if supported by the
the user provider implementation for the concrete user attribute.
Searching for exact match of the search criteria.
Exception thrown by the XML parser in the RFC communication when using
complex parameters or if the function module is tagged in the metadata
to use binary ASXML as serialization format on the line.