ifs.fnd.ap

Class Server

java.lang.Object

ifs.fnd.ap.Server

public class Server
extends java.lang.Object

This class is used for accessing Extended Server components.

For examples on invoking server operations and working with records, see the Foundation1 Development Guide.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	debugMode
protected Statistics	stats

Constructor Summary

Constructors

Constructor and Description
Server() Default constructor.
Server(RetryStrategy retryStrategy) Constructor where the server retry strategy is supplied.
Server(RetryStrategy retryStrategy, int retryCount) Constructor setting the retry strategy & retry count.

Method Summary

Modifier and Type	Method and Description
void	addManualDecisionListener(ManualDecisionListener listener) Register a ManualDecisionListener with this object.
void	disconnect() Disconnects all cached connections to servers.
java.lang.String	getAllMessages() Returns all user info messages in one String with a line separator in between.
java.lang.String	getAllMessages(java.lang.String separator) Gets all user info messages separated by separator.
BodyType	getBodyType() Returns the type of the last response's body content.
CallRouter	getCallRouter() Returns a reference to the CallRouter object for this class.
java.lang.String	getClientId() Gets the client ID for the current request.
java.lang.String	getConnectionString() Gets the current connection string used for server communication.
java.io.OutputStream	getDebugOut() Returns the OutputStream where debug traces are printed on when running in debug mode.
RequestContext	getDefaultRequestContext() Returns the default request context used.
byte[]	getLastRequestBody() Returns the last request's body content, when running in debug mode.
java.lang.String	getLastRequestHeader() Returns the last request's header information, when running in debug mode.
byte[]	getLastResponseBody() Returns the last response's body content, when running in debug mode.
java.lang.String	getLastResponseHeader() Returns the response's header information, when running in debug mode.
java.util.Locale	getLocale() Returns the Locale set.
java.lang.String[]	getMessages() Gets all user info messages that was generated during the last call.
RetryStrategy	getRetryStrategy() Returns the retry strategy used in this object.
Statistics	getStatistics() Returns a Statistics object where some statistics on invoke calls are held.
Trace	getTrace() Returns a reference to a Trace object.
ifs.fnd.buffer.Buffer	invoke(java.lang.String interfaceName, java.lang.String operationName, ifs.fnd.buffer.Buffer requestBody) Minimum info-version of invoke.
ifs.fnd.buffer.Buffer	invoke(java.lang.String interfaceName, java.lang.String operationName, ifs.fnd.buffer.Buffer requestBody, RequestContext requestContext)
ifs.fnd.buffer.Buffer	invoke(java.lang.String interfaceName, java.lang.String operationName, ifs.fnd.buffer.Buffer requestBody, RequestContext requestContext, java.lang.String connectionString) Invokes a server call with a Buffer as input data.
ifs.fnd.buffer.Buffer	invoke(java.lang.String interfaceName, java.lang.String operationName, ifs.fnd.buffer.Buffer requestBody, java.lang.String connectionString)
byte[]	invoke(java.lang.String interfaceName, java.lang.String operationName, byte[] requestBody, BodyType bodyType, RequestContext requestContext, java.lang.String connectionString) Invokes a server operation with a byte array as the request body.
Record	invoke(java.lang.String interfaceName, java.lang.String operationName, Record rec) Invoke-method with a minimum of information supplied to make the call.
Record	invoke(java.lang.String interfaceName, java.lang.String operationName, Record rec, RequestContext requestContext)
Record	invoke(java.lang.String interfaceName, java.lang.String operationName, Record rec, RequestContext requestContext, java.lang.String connectionString) Invokes a server operation according to given data.
Record	invoke(java.lang.String interfaceName, java.lang.String operationName, Record rec, java.lang.String connectionString)
RecordCollection	invokePLSQL(java.lang.String stmt) Invokes a PLSQL command through the AccessPlsql interface.
RecordCollection	invokePLSQL(java.lang.String stmt, Record bindVariables) Invokes a PLSQL command through the AccessPlsql interface.
RecordCollection	invokePLSQL(java.lang.String stmt, Record bindVariables, long maxRows, long skipRows) Invokes a PLSQL command through the PL/SQL Gateway interface for client applications (AccessPlsql).
boolean	isClientStatisticsOn() Returns the flag controlling SQL trace statistics in database.
boolean	isClientTracingOn() Returns the flag controlling SQL tracing in database.
boolean	isDebugMode() Returns whether this object is running in debug mode or not.
boolean	isInteractiveMode() Returns whether interactive mode is used or not.
protected void	log(java.lang.String msg) Prints an event to the debug log.
protected void	log(java.lang.String msg, java.lang.String msg2) Prints an event to the debug log.
void	removeManualDecisionListener(ManualDecisionListener listener) Unregisters a ManualDecisionListener from this object.
void	saveToThread() Saves a reference to this object in the currently executing thread.
void	setClientId(java.lang.String clientId) Sets the client ID for the current request.
void	setClientStatistics(boolean flag) Sets the flag controlling SQL trace statistics in database.
void	setClientTracing(boolean flag) Sets the flag controlling SQL tracing in database.
void	setConnectionString(java.lang.String cs) Sets the connection string to use for server communication.
void	setCredentials(java.lang.String identification, java.lang.String password) Sets the credentials used to authenticate the user.
void	setDebugMode(boolean on) Sets wheter to run this object in debug mode or not.
void	setDebugOut(java.io.OutputStream out) Sets the OutputStream where debug traces are printed on when running in debug mode.
void	setDebugOut(java.io.PrintStream out) Sets the PrintStream where debug traces are printed on when running in debug mode.System.out is the default.
void	setDecisions(ManualDecisionCollection decisions) Sets the collection of manual decisions to be included in the next (and the next only) server call.
void	setDefaultRequestContext(RequestContext ctx) Sets the default request context.
void	setIntegrationUrl(boolean isIntUrl) Set/unset usage of client gateway URL at Integration cluster (default Main)
void	setInteractiveMode(boolean on) Sets wheter to use interactive mode or not.
void	setLegacyUrl(boolean isLegacyUrl) Set/unset usage of client gateway URL in backward compatibility mode (default false)
void	setLocale(java.util.Locale locale) Sets the Locale to use.
void	setLocale(java.lang.String locale) Sets the locale to use (language actually, an IFS specific language code).
void	setRetryStrategy(RetryStrategy retryStrategy) Sets the retry strategy for this object.
void	setRunAs(java.lang.String directoryId) Sets the directory id of an alternative user to run the server calls as.
void	setSqlTrace(boolean enable) Sets whether SQL Trace is enabled or not.
void	setUseCompression(boolean on) Sets whether data compression is used or not.
boolean	sqlTrace() Returns whether SQL Trace is enabled or not.
boolean	useCompression() Returns whether data compression is used or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

debugMode

protected boolean debugMode

stats

protected Statistics stats

Constructor Detail

Server

public Server()

Default constructor. The server retry strategy is set to RETRY_AUTO. In most cases, this constructor is the most appropriate.

Server

public Server(RetryStrategy retryStrategy)

Constructor where the server retry strategy is supplied. retryCount is set to 2.

Parameters:

retryStrategy -

Server

public Server(RetryStrategy retryStrategy,
              int retryCount)

Constructor setting the retry strategy & retry count.

Parameters:

retryStrategy -

retryCount -

Method Detail

disconnect

public void disconnect()

Disconnects all cached connections to servers.

getDebugOut

public java.io.OutputStream getDebugOut()

Returns the OutputStream where debug traces are printed on when running in debug mode. Default is System.out.

Returns:

getDefaultRequestContext

public RequestContext getDefaultRequestContext()

Returns the default request context used.

Returns:

getCallRouter

public CallRouter getCallRouter()

Returns a reference to the CallRouter object for this class.

Returns:

getLocale

public java.util.Locale getLocale()

Returns the Locale set.

Returns:

getLastRequestBody

public byte[] getLastRequestBody()

Returns the last request's body content, when running in debug mode.

Returns:

getLastRequestHeader

public java.lang.String getLastRequestHeader()

Returns the last request's header information, when running in debug mode.

Returns:

getLastResponseBody

public byte[] getLastResponseBody()

Returns the last response's body content, when running in debug mode.

Returns:

getLastResponseHeader

public java.lang.String getLastResponseHeader()

Returns the response's header information, when running in debug mode.

Returns:

getMessages

public java.lang.String[] getMessages()

Gets all user info messages that was generated during the last call.

Returns:

getAllMessages

public java.lang.String getAllMessages()

Returns all user info messages in one String with a line separator in between.

Returns:

getAllMessages

public java.lang.String getAllMessages(java.lang.String separator)

Gets all user info messages separated by separator.

Parameters:

separator -

Returns:

getBodyType

public BodyType getBodyType()

Returns the type of the last response's body content.

Returns:

getRetryStrategy

public RetryStrategy getRetryStrategy()

Returns the retry strategy used in this object.

Returns:

getStatistics

public Statistics getStatistics()

Returns a Statistics object where some statistics on invoke calls are held. It includes among other things a performance evaluation.

Returns:

See Also:

Statistics

getTrace

public Trace getTrace()

Returns a reference to a Trace object.

Returns:

See Also:

Trace

isDebugMode

public boolean isDebugMode()

Returns whether this object is running in debug mode or not.

Returns:

isInteractiveMode

public boolean isInteractiveMode()

Returns whether interactive mode is used or not.

Returns:

See Also:

setInteractiveMode(boolean)

sqlTrace

public boolean sqlTrace()

Returns whether SQL Trace is enabled or not.

Returns:

See Also:

setSqlTrace(boolean)

setSqlTrace

public void setSqlTrace(boolean enable)

Sets whether SQL Trace is enabled or not.

Parameters:

enable - if true Enable SQL Trace.

setClientId

public void setClientId(java.lang.String clientId)

Sets the client ID for the current request. The client ID is used to identify SQL Trace files generated by the database server.

Parameters:

clientId - String identifying the client

See Also:

setClientTracing(boolean), setClientStatistics(boolean)

setClientTracing

public void setClientTracing(boolean flag)

Sets the flag controlling SQL tracing in database.

Parameters:

flag - true if SQL trace statistics should be generated, false otherwise

See Also:

setClientId(String)

setClientStatistics

public void setClientStatistics(boolean flag)

Sets the flag controlling SQL trace statistics in database.

Parameters:

flag - true if SQL trace statistics should be generated, false otherwise

See Also:

setClientId(String)

getClientId

public java.lang.String getClientId()

Gets the client ID for the current request. The client ID is used to identify SQL Trace files generated by the database server.

Returns:

String identifying the client

See Also:

isClientTracingOn(), isClientStatisticsOn()

isClientTracingOn

public boolean isClientTracingOn()

Returns the flag controlling SQL tracing in database.

Returns:

true if SQL trace should be activated, false otherwise

See Also:

setClientTracing(boolean)

isClientStatisticsOn

public boolean isClientStatisticsOn()

Returns the flag controlling SQL trace statistics in database.

Returns:

true if SQL trace statistics should be generated, false otherwise

See Also:

setClientStatistics(boolean)

setUseCompression

public void setUseCompression(boolean on)

Sets whether data compression is used or not.

Parameters:

on - if true compression is used.

useCompression

public boolean useCompression()

Returns whether data compression is used or not.

Returns:

true if compression is used.

setIntegrationUrl

public void setIntegrationUrl(boolean isIntUrl)

Set/unset usage of client gateway URL at Integration cluster (default Main)

Parameters:

isIntUrl -

setLegacyUrl

public void setLegacyUrl(boolean isLegacyUrl)

Set/unset usage of client gateway URL in backward compatibility mode (default false)

Parameters:

isLegacyUrl -

invoke

public Record invoke(java.lang.String interfaceName,
                     java.lang.String operationName,
                     Record rec)
              throws APException

Invoke-method with a minimum of information supplied to make the call. Sets the rest to default values (null).

Parameters:

interfaceName -

operationName -

rec -

Returns:

Throws:

APException

See Also:

invoke(java.lang.String,java.lang.String,ifs.fnd.ap.Record,ifs.fnd.ap.RequestContext,java.lang.String)

invoke

public Record invoke(java.lang.String interfaceName,
                     java.lang.String operationName,
                     Record rec,
                     RequestContext requestContext)
              throws APException

Parameters:

interfaceName -

operationName -

rec -

requestContext -

Returns:

Throws:

APException

See Also:

invoke(java.lang.String,java.lang.String,ifs.fnd.ap.Record,ifs.fnd.ap.RequestContext ,java.lang.String)

invoke

public Record invoke(java.lang.String interfaceName,
                     java.lang.String operationName,
                     Record rec,
                     java.lang.String connectionString)
              throws APException

Parameters:

interfaceName -

operationName -

rec -

connectionString -

Returns:

Throws:

APException

See Also:

invoke(java.lang.String,java.lang.String,ifs.fnd.ap.Record,ifs.fnd.ap.RequestContext ,java.lang.String)

invoke

public Record invoke(java.lang.String interfaceName,
                     java.lang.String operationName,
                     Record rec,
                     RequestContext requestContext,
                     java.lang.String connectionString)
              throws APException

Invokes a server operation according to given data.

Parameters:

interfaceName - The name of the interface to be called.

operationName - The name of the operation to be called.

rec - The record containing the input data for the call.

requestContext - the request context in which the call is made. Default is null.

connectionString - a connection string to use for this invokation. Default is null (=use the one set on this Server object).

Returns:

a record with the result of the server call.

Throws:

APException - when server calls fails of various reasons. If it's caused by a standard exception, then the original exception is wrapped and accessible via APException.getRootCause().

invoke

public ifs.fnd.buffer.Buffer invoke(java.lang.String interfaceName,
                                    java.lang.String operationName,
                                    ifs.fnd.buffer.Buffer requestBody)
                             throws APException,
                                    ifs.fnd.service.FndException

Minimum info-version of invoke.

Parameters:

interfaceName -

operationName -

requestBody -

Returns:

Throws:

APException

ifs.fnd.service.FndException

See Also:

invoke(java.lang.String, java.lang.String, ifs.fnd.buffer.Buffer, ifs.fnd.ap.RequestContext, java.lang.String)

invoke

public ifs.fnd.buffer.Buffer invoke(java.lang.String interfaceName,
                                    java.lang.String operationName,
                                    ifs.fnd.buffer.Buffer requestBody,
                                    RequestContext requestContext)
                             throws APException,
                                    ifs.fnd.service.FndException

Parameters:

interfaceName -

operationName -

requestBody -

requestContext -

Returns:

Throws:

APException

ifs.fnd.service.FndException

See Also:

invoke(java.lang.String, java.lang.String, ifs.fnd.buffer.Buffer, ifs.fnd.ap.RequestContext, java.lang.String)

invoke

public ifs.fnd.buffer.Buffer invoke(java.lang.String interfaceName,
                                    java.lang.String operationName,
                                    ifs.fnd.buffer.Buffer requestBody,
                                    java.lang.String connectionString)
                             throws APException,
                                    ifs.fnd.service.FndException

Parameters:

interfaceName -

operationName -

requestBody -

connectionString -

Returns:

Throws:

APException

ifs.fnd.service.FndException

See Also:

invoke(java.lang.String, java.lang.String, ifs.fnd.buffer.Buffer, ifs.fnd.ap.RequestContext, java.lang.String)

invoke

public ifs.fnd.buffer.Buffer invoke(java.lang.String interfaceName,
                                    java.lang.String operationName,
                                    ifs.fnd.buffer.Buffer requestBody,
                                    RequestContext requestContext,
                                    java.lang.String connectionString)
                             throws APException,
                                    ifs.fnd.service.FndException

Invokes a server call with a Buffer as input data.

Parameters:

interfaceName - The interface to bind to.

operationName - The operation to invoke.

requestBody - A buffer containing the input data for the server call.

requestContext - the request context in which the call is made. Default is null.

connectionString - a connection string to use for this invokation. Default is null (=use the one set on this Server object).

Returns:

A Buffer containing the response's body.

Throws:

ifs.fnd.service.FndException

APException

invoke

public byte[] invoke(java.lang.String interfaceName,
                     java.lang.String operationName,
                     byte[] requestBody,
                     BodyType bodyType,
                     RequestContext requestContext,
                     java.lang.String connectionString)
              throws APException,
                     ifs.fnd.service.FndException

Invokes a server operation with a byte array as the request body.

Parameters:

interfaceName - the interface to bind to.

operationName - the operation to invoke.

requestBody - the request's body to send to the operation. Must be an IFS Buffer or XML document.

bodyType - the type of the body content.

requestContext - the request context in which the call is made. Default is null.

connectionString - a connection string to use for this invokation. Default is null (=use the one set on this Server object).

Returns:

Throws:

APException

ifs.fnd.service.FndException

invokePLSQL

public RecordCollection invokePLSQL(java.lang.String stmt)
                             throws APException

Invokes a PLSQL command through the AccessPlsql interface. A more convenient and flexible way to invoke PL/SQL code and do queries is to use the PL/SQL Command Block functionality. That functionality also allows for executing multiple commands in one call.

Parameters:

stmt -

Returns:

Throws:

APException

See Also:

invokePLSQL(String, ifs.fnd.ap.Record, long, long)

invokePLSQL

public RecordCollection invokePLSQL(java.lang.String stmt,
                                    Record bindVariables)
                             throws APException

Invokes a PLSQL command through the AccessPlsql interface. A more convenient and flexible way to invoke PL/SQL code and do queries is to use the PL/SQL Command Block functionality. That functionality also allows for executing multiple commands in one call.

Parameters:

stmt -

bindVariables -

Returns:

Throws:

APException

See Also:

invokePLSQL(String, ifs.fnd.ap.Record, long, long)

invokePLSQL

public RecordCollection invokePLSQL(java.lang.String stmt,
                                    Record bindVariables,
                                    long maxRows,
                                    long skipRows)
                             throws APException

Invokes a PLSQL command through the PL/SQL Gateway interface for client applications (AccessPlsql). Default parameter info below states the values used by overloaded versions of this method.

A more convenient and flexible way to invoke PL/SQL code and do queries is to use the PL/SQL Command Block functionality. That functionality also allows for executing multiple commands in one call.

Parameters:

stmt - the SQL statement to run.

bindVariables - A record containing the bind variables, if any (default is null).

maxRows - the maximum number of rows to return for the statement (default is 100).

skipRows - if set to n, then the n first rows the result is not returned in the result set (default is 0).

Returns:

A RecordCollection containing the result set from the SQL statement. If there is no result set returned from the statement, null is returned.

Throws:

APException - if the call does not go well.

saveToThread

public void saveToThread()

Saves a reference to this object in the currently executing thread. This reference is not available for public use. It is used by generated client access handlers.

See Also:

FndClientAccessHandler

setLocale

public void setLocale(java.lang.String locale)

Sets the locale to use (language actually, an IFS specific language code). This method will be made deprecated in a future release. Use setLocale(java.util.Locale) instead with both language and country codes.

Parameters:

locale -

See Also:

setLocale(java.util.Locale)

setLocale

public void setLocale(java.util.Locale locale)

Sets the Locale to use.

Parameters:

locale -

setCredentials

public void setCredentials(java.lang.String identification,
                           java.lang.String password)

Sets the credentials used to authenticate the user.

Parameters:

identification - the user's identification.

password - the user's password.

setRunAs

public void setRunAs(java.lang.String directoryId)

Sets the directory id of an alternative user to run the server calls as. Alternative as in one that is different form the one set in the setCredentials() call. This directory id is used for security- and authorization-related checks on the server-side. Normal user authentication is still peformed and only a pre-defined set of users may use an alternative directory id.

Parameters:

directoryId - the directory id of a user to run as.

setDebugOut

public void setDebugOut(java.io.OutputStream out)

Sets the OutputStream where debug traces are printed on when running in debug mode. System.out is the default.

Parameters:

out -

setDebugOut

public void setDebugOut(java.io.PrintStream out)

Sets the PrintStream where debug traces are printed on when running in debug mode.System.out is the default.

Parameters:

out -

setDebugMode

public void setDebugMode(boolean on)

Sets wheter to run this object in debug mode or not. When debug mode is on, the invoke methods produces traces of what's happening. There is an alternative way of setting the debug mode by setting the system property ifs.fnd.ap.debug to "true" before creating this object. By default, debug traces are produced to System.out.

Parameters:

on -

See Also:

setDebugOut(java.io.PrintStream)

setDecisions

public void setDecisions(ManualDecisionCollection decisions)

Sets the collection of manual decisions to be included in the next (and the next only) server call. This must be made if a previous server call threw a ManualDecisionException.

Parameters:

decisions -

See Also:

ManualDecisionException

setDefaultRequestContext

public void setDefaultRequestContext(RequestContext ctx)

Sets the default request context.

Parameters:

ctx - the requst context to set. May not be null.

getConnectionString

public java.lang.String getConnectionString()

Gets the current connection string used for server communication.

Returns:

setConnectionString

public void setConnectionString(java.lang.String cs)

Sets the connection string to use for server communication.

Parameters:

cs -

setInteractiveMode

public void setInteractiveMode(boolean on)

Sets wheter to use interactive mode or not. If interactive mode is used, then a server may ask the user (client application) for manual decisions.

Parameters:

on -

setRetryStrategy

public void setRetryStrategy(RetryStrategy retryStrategy)

Sets the retry strategy for this object.

Parameters:

retryStrategy -

log

protected void log(java.lang.String msg)

Prints an event to the debug log.

Parameters:

msg -

log

protected void log(java.lang.String msg,
                   java.lang.String msg2)

Prints an event to the debug log.

Parameters:

msg -

msg2 -

addManualDecisionListener

public void addManualDecisionListener(ManualDecisionListener listener)

Register a ManualDecisionListener with this object. The listeners are invoked when a server requests a manual decision. One listener can only be added once. If more than one listener is registered, the first listener will recieve all decision requests and if not all decisions have been answered, the next listner will recieve an event for the remaining decisions to be made.

Adding a listener sets the access provider into interactive mode.

Parameters:

listener -

See Also:

ManualDecisionListener, setInteractiveMode(boolean)

removeManualDecisionListener

public void removeManualDecisionListener(ManualDecisionListener listener)

Unregisters a ManualDecisionListener from this object.

Parameters:

listener -

See Also:

ManualDecisionListener