com.gmcb.plandk3.server

Class PdkMethodContext

java.lang.Object

com.gmcb.plandk3.server.PdkMethodContext

public class PdkMethodContext
extends java.lang.Object

This class resembles all state-information related to a client's invocation of a SOAP-method in the Pdk3Ws end-point.

Author:

ArO

Constructor Summary

Constructors

Constructor and Description
PdkMethodContext(PdkWsCommon endPoint, PdkApi pdkApi, PdkMethod method, java.lang.String userName, java.lang.String pwd, java.lang.String ipAdress, java.lang.String url)

Method Summary

Modifier and Type	Method and Description
void	abort() Convenience method for invoking getMethodResult().abort()
boolean	doRuleCheck()
java.lang.String	getClientIpAdress() Yes
JdbcConnection	getErrDBC() Get database connection to perform transactions in a "logging" transaction context
boolean	getForceRollback() TODO: This method is questionable: Status ERROR signifies "rollback" - other situations need to be explored
java.lang.String	getGistoolsVersion()
PdkMethod	getMethod() Which Pdk method is actually invoked?
java.lang.String	getMethodName() What is the Pdk3 name of the soap method currently invoked?
PdkMethodResult	getMethodResult() Get the result created by the PdkMethod in question
java.lang.String	getPassword() Get the password-arg
PdkApi	getPdkApi()
java.lang.String	getPdkBuild()
java.lang.String	getPdkVersion()
java.lang.String	getSignature() What is the "memnotic" signature of the Pdk method currently invoked?
User	getUser() Get the authenticated User member.
java.lang.String	getUserName() Get the user-arg
JdbcConnection	getWorkDBC() Get database connection to perform transactions in a "work" transaction context
void	invokeMethod() Perform the SOAP method invocation - PdkMethodInvocer.invoke(). This method performs all the trivial logic "surrounding" a SOAP method invocation, such as user authentification and proper exception handling.
boolean	isAuthenticate() Get the authentication behavior of this method invocation
void	setArgs(java.lang.String... args) Set "memnotic" arguments
void	setAuthenticate(boolean doAuth) By default all SOAP method invocations are performed with user authentication. This method allows for this behavior to be overridden.
void	setForceRollback() TODO: This method is questionable: Status ERROR signifies "rollback" - other situations need to be explored
void	setInvoker(PdkMethodInvoker inv) Set the PdkMethodInvoker implementation to perform the SOAP method logic of this invocation
void	setUser(User user) Set the authenticated User member

Methods inherited from class java.lang.Object

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

Constructor Detail

PdkMethodContext

public PdkMethodContext(PdkWsCommon endPoint,
                        PdkApi pdkApi,
                        PdkMethod method,
                        java.lang.String userName,
                        java.lang.String pwd,
                        java.lang.String ipAdress,
                        java.lang.String url)
                 throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

setAuthenticate

public void setAuthenticate(boolean doAuth)

By default all SOAP method invocations are performed with user authentication.
This method allows for this behavior to be overridden.

Parameters:

doAuth - Yes. Do it or not.

isAuthenticate

public boolean isAuthenticate()

Get the authentication behavior of this method invocation

setArgs

public void setArgs(java.lang.String... args)

Set "memnotic" arguments

getMethod

public PdkMethod getMethod()

Which Pdk method is actually invoked?

getMethodName

public java.lang.String getMethodName()

What is the Pdk3 name of the soap method currently invoked?

getSignature

public java.lang.String getSignature()

What is the "memnotic" signature of the Pdk method currently invoked?

setInvoker

public void setInvoker(PdkMethodInvoker inv)

Set the PdkMethodInvoker implementation to perform the SOAP method logic of this invocation

getClientIpAdress

public java.lang.String getClientIpAdress()

Yes

getUserName

public java.lang.String getUserName()

Get the user-arg

getPassword

public java.lang.String getPassword()

Get the password-arg

setUser

public void setUser(User user)

Set the authenticated User member

getUser

public User getUser()

Get the authenticated User member. Returns null if not authenticated.

getPdkApi

public PdkApi getPdkApi()

abort

public void abort()

Convenience method for invoking getMethodResult().abort()

getWorkDBC

public JdbcConnection getWorkDBC()
                          throws java.lang.Exception

Get database connection to perform transactions in a "work" transaction context

Throws:

java.lang.Exception

getErrDBC

public JdbcConnection getErrDBC()
                         throws java.lang.Exception

Get database connection to perform transactions in a "logging" transaction context

Throws:

java.lang.Exception

setForceRollback

public void setForceRollback()

TODO: This method is questionable: Status ERROR signifies "rollback" - other situations need to be explored

getForceRollback

public boolean getForceRollback()

TODO: This method is questionable: Status ERROR signifies "rollback" - other situations need to be explored

getMethodResult

public PdkMethodResult getMethodResult()

Get the result created by the PdkMethod in question

getPdkVersion

public java.lang.String getPdkVersion()

getPdkBuild

public java.lang.String getPdkBuild()

getGistoolsVersion

public java.lang.String getGistoolsVersion()

doRuleCheck

public boolean doRuleCheck()

invokeMethod

public void invokeMethod()
                  throws java.lang.Exception

Perform the SOAP method invocation - PdkMethodInvocer.invoke().
This method performs all the trivial logic "surrounding" a SOAP method invocation, such as user authentification and proper exception handling.

Throws:

java.lang.Exception