|
BEA Systems, Inc. | |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweblogic.common.T3Client
Class for creating and managing T3Clients. A T3Client must be constructed with the URL of the WebLogic Server that it will connect to. A T3Client may access many services within WebLogic.
The URL for constructing the T3Client follows the pattern:
scheme://WebLogicHost:portThe scheme identifies the client access. Valid schemes are currently:
A T3Client has a Workspace inside the WebLogic Server that can be named and saved, so that the T3Client can disconnect and then return later to the same Workspace. The T3Client Workspace is at the lowest level of a hierarchy of Workspaces that exist for WebLogic Clusters, WebLogic Servers, T3Users and groups, and T3Clients. T3Clients can set various timeouts to control disconnects from the WebLogic Server; a T3Client can also add entries to the WebLogic logfile, and can store and fetch arbitrary objects from its own Workspace or the other Workspaces within its access.
T3ServicesDef
Field Summary | |
static int |
DISCONNECT_TIMEOUT_DEFAULT
The default DISCONNECT_TIMEOUT value set in the server configuration. |
static int |
DISCONNECT_TIMEOUT_NEVER
Disables disconnect altogether. |
static int |
INVALID_CALLBACK_ID
|
T3ServicesDef |
services
Defines the WebLogic services that a T3Client can access. |
Constructor Summary | |
T3Client(String url)
Constructs a T3Client. |
|
T3Client(String url,
String workspace)
Constructs a T3Client. |
|
T3Client(String url,
String workspace,
UserInfo t3u)
Constructs a T3Client. |
|
T3Client(String url,
UserInfo t3u)
Constructs a T3Client. |
|
T3Client(T3Connection conn)
Constructs a T3Client over the specified T3Connection. |
|
T3Client(T3Connection conn,
String workspace)
Creates a T3Client object, given an existing T3Connection and Workspace name. |
Method Summary | |
void |
addDisconnectListener(DisconnectListener dl)
Adds a T3Client to the list of those clients listening for a DisconnectEvent. |
T3Client |
connect()
Connects the T3Client to a WebLogic Server. |
T3Client |
disconnect()
Disconnects a T3Client from the WebLogic Server. |
void |
dispatch(Throwable problem,
Object msg)
|
int |
getHardDisconnectTimeoutMins()
Gets the value for a T3Client's hard disconnect timeout in minutes. |
int |
getIdleDisconnectTimeoutMins()
Gets the value for a T3Client's idle disconnect timeout in minutes. |
String |
getServerName()
Gets the name of the WebLogic Server to which the T3Client is currently connected. |
int |
getSoftDisconnectTimeoutMins()
Gets the value for a T3Client's soft disconnect timeout in minutes. |
T3Connection |
getT3Connection()
Returns the T3Connection object by which a T3Client is connected to a WebLogic Server. |
T3ServicesDef |
getT3Services()
Returns the WebLogic services that a T3Client can access. |
boolean |
getVerbose()
Gets the verbose setting for a T3Client. |
boolean |
isConnected()
Determines whether the T3Client is connected to a WebLogic Server, that is, whether the connect() method has been called for this T3Client and the T3Client is currently connected. |
Class |
loadClass(String className)
|
void |
peerGone(weblogic.rjvm.PeerGoneEvent pge)
|
weblogic.rjvm.RJVM |
private_getRJVM()
|
void |
removeDisconnectListener(DisconnectListener dl)
Removes a T3Client from the list of those clients listening for a DisconnectEvent. |
void |
sendOneWay(String clss,
Object o)
|
Object |
sendRecv(String clss,
Object o)
|
weblogic.rjvm.Response |
sendRecvAsync(String clss,
Object o)
Replaces sendRecv and sendLazy/recv, because it is non-blocking. |
T3Client |
setHardDisconnectTimeoutMins(int minutes)
Sets the value for a T3Client's hard disconnect timeout in minutes. |
T3Client |
setIdleDisconnectTimeoutMins(int minutes)
Sets the value for a T3Client's idle disconnect timeout in minutes. |
T3Client |
setSoftDisconnectTimeoutMins(int minutes)
Sets the value for a T3Client's soft disconnect timeout in minutes. |
T3Client |
setVerbose(boolean verbose)
Sets the verbose setting for a T3Client. |
boolean |
timeTraceEnable(PrintStream ps)
|
boolean |
timeTraceEnabled()
|
String |
toString()
Returns a string representation of the T3Client, including the name of the host, the port to which it is connected, and its Workspace ID. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int DISCONNECT_TIMEOUT_DEFAULT
public static final int DISCONNECT_TIMEOUT_NEVER
public static final int INVALID_CALLBACK_ID
public T3ServicesDef services
T3ServletDef t3s = t3.services.remote().getT3Servlet("tutorial.t3client.StartupQuery"); t3s.execute(ps);
Constructor Detail |
public T3Client(String url) throws UnknownHostException, weblogic.common.T3Exception, IOException
UnknownHostException
- if the
URL for the WebLogic Server is invalid
weblogic.common.T3Exception
- if there is an error
creating the T3Client
IOException
- if there is
an IO error with the connectionpublic T3Client(String url, String workspace) throws UnknownHostException, weblogic.common.T3Exception, IOException
The Workspace is the name or ID of an existing Workspace; if there is no Workspace on the WebLogic Server with that name or ID, the argument is assumed to be the name of a new T3Client Workspace that is to be created. When you specify the name of a Workspace on WebLogic, that name is implicitly qualified on the left by the UserInfo's username, after the pattern "username:workspaceName". The default UserInfo is "T3User.GUEST".
UnknownHostException
- if the
URL for the WebLogic Server is invalid
weblogic.common.T3Exception
- if there is an error
creating the T3Client
IOException
- if there is
an IO error with the connectionpublic T3Client(String url, String workspace, UserInfo t3u) throws UnknownHostException, weblogic.common.T3Exception, IOException
The Workspace is the name or ID of an existing Workspace; if there is no Workspace on the WebLogic Server with that name or ID, the argument is assumed to be the name of a new T3Client Workspace that is to be created. When you specify the name of a Workspace on WebLogic, that name is implicitly qualified on the left by the UserInfo's username, after the pattern "username:workspaceName".
UnknownHostException
- if the
URL for the WebLogic Server is invalid
weblogic.common.T3Exception
- if there is an error
creating the T3Client
IOException
- if there is
an IO error with the connectionpublic T3Client(String url, UserInfo t3u) throws UnknownHostException, weblogic.common.T3Exception, IOException
UnknownHostException
- if the
URL for the WebLogic Server is invalid
weblogic.common.T3Exception
- if there is an error
creating the T3Client
IOException
- if there is
an IO error with the connectionpublic T3Client(T3Connection conn)
public T3Client(T3Connection conn, String workspace)
The Workspace is the name or ID of an existing Workspace; if there is no Workspace on the WebLogic Server with that name or ID, the argument is assumed to be the name of a new T3Client Workspace that is to be created. When you specify the name of a Workspace on the WebLogic Server, that name is implicitly qualified on the left by the UserInfo's username, after the pattern "username:workspaceName".
Method Detail |
public void addDisconnectListener(DisconnectListener dl)
dl
- DisconnectListenerpublic T3Client connect() throws IOException, weblogic.common.T3Exception, weblogic.common.T3ExecuteException, SecurityException
IOException
- if an IO error occurs
weblogic.common.T3Exception
- if there is an error with the connect request
weblogic.common.T3ExecuteException
- if there is an error with the connect request
SecurityException
- if there is an error with the connect requestpublic T3Client disconnect() throws IOException, weblogic.common.T3Exception
Check the Developers Guide, Writing a T3Client application, in the WebLogic Server documentation, for info on how to set up a T3Client to listen for its own disconnect event. A T3Client can listen for a disconnect event that is the result of a soft or idle disconnect timeout.
IOException
- if an IO error occurs
weblogic.common.T3Exception
- if there is an error with the disconnect requestpublic void dispatch(Throwable problem, Object msg)
dispatch
in interface ClientCallback
public int getHardDisconnectTimeoutMins()
public int getIdleDisconnectTimeoutMins()
Check the Developers Guide, Writing a T3Client application, in the WebLogic Server documentation, for more info on how to set up a T3Client to listen for its own disconnect event.
public String getServerName()
public int getSoftDisconnectTimeoutMins()
disconnect()
public T3Connection getT3Connection()
public T3ServicesDef getT3Services()
public boolean getVerbose()
public boolean isConnected()
Also see Writing a T3Client application, in the WebLogic Server documentation, on how to set up a T3Client to listen for its own disconnect event.
connect()
public Class loadClass(String className) throws ClassNotFoundException
ClassNotFoundException
public void peerGone(weblogic.rjvm.PeerGoneEvent pge)
peerGone
in interface weblogic.rjvm.PeerGoneListener
public weblogic.rjvm.RJVM private_getRJVM()
public void removeDisconnectListener(DisconnectListener dl)
dl
- DisconnectListenerpublic void sendOneWay(String clss, Object o) throws RemoteException
RemoteException
public Object sendRecv(String clss, Object o) throws weblogic.common.T3Exception
weblogic.common.T3Exception
public weblogic.rjvm.Response sendRecvAsync(String clss, Object o) throws RemoteException
RemoteException
- if there is an errorpublic T3Client setHardDisconnectTimeoutMins(int minutes) throws RemoteException, weblogic.common.T3Exception
minutes
- Delay before cleanup after a
hard disconnect occurs
RemoteException
- if there is an error
weblogic.common.T3Exception
public T3Client setIdleDisconnectTimeoutMins(int minutes) throws RemoteException, weblogic.common.T3Exception
minutes
- Minutes
RemoteException
- if there is an error
weblogic.common.T3Exception
- if the timeout value
is invalid or if it cannot be setpublic T3Client setSoftDisconnectTimeoutMins(int minutes) throws RemoteException, weblogic.common.T3Exception
Check the Developers Guide, Writing a T3Client application, in the WebLogic Server documentation for more info on how to set up a T3Client to listen for its own disconnect event.
minutes
- Delay after T3Client requests disconnect
RemoteException
- if there is an error
weblogic.common.T3Exception
disconnect()
public T3Client setVerbose(boolean verbose) throws RemoteException
verbose
- True if verbose should be set
RemoteException
- if there is an errorpublic boolean timeTraceEnable(PrintStream ps)
public boolean timeTraceEnabled()
public String toString()
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs91 Copyright 2005 BEA Systems Inc. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |