|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sap.conn.jco.ext.Environment
public abstract class Environment
The Environment class is the central anchor for embedding JCo into an existing application (server).
Typically, only infrastructure programmers will have the need to deal with that class. Business
application logic typically can be developed without knowing the infrastructure.
For the infrastrucure embedding you can register, deregister and check for the existence of several
components: Configuration providers (DestinationDataProvider
, ServerDataProvider
),
Session Management (SessionReferenceProvider
), Password Handler PasswordChangeHandler
,
and Passport Managers for E2E scenario analysis ({link ClientPassportManager
, ServerPassportManager
}).
Moreover, it allows finding out about the current runtime environment, which might be useful for
components that exist in several ones.
Method Summary | |
---|---|
static boolean |
inDW()
Allows to check, whether the current runtime environment is a DW, which is a flavor of JTS. |
static boolean |
inDWJ()
Allows to check, whether the current runtime environment is a DWJ, which is a flavor of JTS. |
static boolean |
inEclipsePlugin()
Allows to check, whether the JCo was loaded as eclipse plugin within the current environment, which means the application is in a standalone environment and probably run in eclipse. |
static boolean |
inJStartup()
Allows to check, whether the current runtime environment has been started by a Java Startup framework. |
static boolean |
inJTS()
Allows to check, whether the current runtime environment is a JTS. |
static boolean |
inSAPJ2EE()
Allows to check, whether the current runtime environment is an SAP J2EE engine. |
static boolean |
inSAPVM()
Allows to check, whether the current Java virtual machine is a VM provided by SAP. |
static boolean |
inStandalone()
Allows to check, whether the current runtime environment is a standalone environment, which means it's neither JTS nor SAP J2EE. |
static boolean |
isClientPassportManagerRegistered()
Checks whether a passport manager for client side communication has already been registered. |
static boolean |
isDestinationDataProviderRegistered()
Checks whether a provider for destination data has already been registered. |
static boolean |
isPasswordChangeHandlerRegistered()
Checks whether a PasswordChangeHandler has already been registered. |
static boolean |
isServerDataProviderRegistered()
Checks whether a provider for server data has already been registered. |
static boolean |
isServerPassportManagerRegistered()
Checks whether a passport manager for server side communication has already been registered. |
static boolean |
isSessionReferenceProviderRegistered()
Checks whether a provider for session references has already been registered. |
static void |
registerClientPassportManager(ClientPassportManager passportManager)
Registers a manager for DSR passports for client side communication. |
static void |
registerDestinationDataProvider(DestinationDataProvider provider)
Registers a provider for destination data. |
static void |
registerPasswordChangeHandler(PasswordChangeHandler passwordChangeHandler)
Registers a handler for password change events. |
static void |
registerServerDataProvider(ServerDataProvider provider)
Registers a provider for destination data. |
static void |
registerServerPassportManager(ServerPassportManager passportManager)
Registers a manager for DSR passports for server side communication. |
static void |
registerSessionReferenceProvider(SessionReferenceProvider provider)
Registers a provider for session reference information. |
static void |
unregisterClientPassportManager(ClientPassportManager passportManager)
Unregisters a manager for DSR passports for client side communication. |
static void |
unregisterDestinationDataProvider(DestinationDataProvider provider)
Unregisters a provider for destination data. |
static void |
unregisterPasswordChangeHandler(PasswordChangeHandler passwordChangeHandler)
Unregisters the handler for password change events. |
static void |
unregisterServePassportManager(ServerPassportManager passportManager)
Unregisters a manager for DSR passports for server side communication. |
static void |
unregisterServerDataProvider(ServerDataProvider provider)
Unregisters a provider for destination data. |
static void |
unregisterSessionReferenceProvider(SessionReferenceProvider provider)
Unregisters a provider for session id data. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static final boolean inSAPVM()
public static final boolean inJTS()
public static final boolean inDW()
public static final boolean inDWJ()
public static final boolean inJStartup()
public static final boolean inSAPJ2EE()
public static final boolean inStandalone()
public static final boolean inEclipsePlugin()
public static void registerDestinationDataProvider(DestinationDataProvider provider)
provider
- the class that provides DestinationData
java.lang.IllegalStateException
- if a provider is already registeredpublic static void registerServerDataProvider(ServerDataProvider provider)
provider
- the class that provides DestinationData
java.lang.IllegalStateException
- if a provider is already registeredpublic static void registerSessionReferenceProvider(SessionReferenceProvider provider)
provider
- the class that provides session reference information
java.lang.IllegalStateException
- if a provider is already registeredpublic static void unregisterDestinationDataProvider(DestinationDataProvider provider)
provider
- the original DestinationDataProvider that should be unregistered
java.lang.IllegalStateException
- if the provider that should be unregistered is not
the one that was originally registeredpublic static void unregisterServerDataProvider(ServerDataProvider provider)
provider
- the class that provides DestinationData
java.lang.IllegalStateException
- IllegalStateException if the provider that should be unregistered is not
the one that was originally registeredpublic static void unregisterSessionReferenceProvider(SessionReferenceProvider provider)
provider
- the original SessionIdProvider that should be unregistered
java.lang.IllegalStateException
- if the provider that should be unregistered is not
the one that was originally registeredpublic static void registerClientPassportManager(ClientPassportManager passportManager)
passportManager
- the class that does client side passport management
java.lang.IllegalStateException
- if a manager is already registeredpublic static void unregisterClientPassportManager(ClientPassportManager passportManager)
passportManager
- the original ClientPassportManager that should be unregistered
java.lang.IllegalStateException
- if the manager that should be unregistered is not
the one that was originally registeredpublic static void registerServerPassportManager(ServerPassportManager passportManager)
passportManager
- the class that does server side passport management
java.lang.IllegalStateException
- if a manager is already registeredpublic static void unregisterServePassportManager(ServerPassportManager passportManager)
passportManager
- the original ServerPassportManager that should be unregistered
java.lang.IllegalStateException
- if the manager that should be unregistered is not
the one that was originally registeredpublic static void registerPasswordChangeHandler(PasswordChangeHandler passwordChangeHandler)
passwordChangeHandler
- the class that reacts on password change queries
java.lang.IllegalStateException
- if a handler is already registeredpublic static void unregisterPasswordChangeHandler(PasswordChangeHandler passwordChangeHandler)
passwordChangeHandler
- the original PasswordChangeHandler that should be unregistered
java.lang.IllegalStateException
- if the handler that should be unregistered is not
the one that was originally registeredpublic static boolean isDestinationDataProviderRegistered()
public static boolean isServerDataProviderRegistered()
public static boolean isSessionReferenceProviderRegistered()
public static boolean isClientPassportManagerRegistered()
public static boolean isServerPassportManagerRegistered()
public static boolean isPasswordChangeHandlerRegistered()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |