com.plumtree.portalpages.admin.editors.webservice.plugins
Class BasicAuthPluginModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorHelperModel
      com.plumtree.portalpages.admin.editors.webservice.plugins.BasicAuthPluginModel

All Implemented Interfaces:

IWSSubModel, IBasicAuthPluginModelRO, IManagedObject, IModel, IModelRO, IMVCObject

public class BasicAuthPluginModel
extends EditorHelperModel
implements IBasicAuthPluginModelRO, IWSSubModel

Author:

adolfoc

Field Summary

static int	AUTHTYPE_ADMIN
static int	AUTHTYPE_LOCKBOX
static int	AUTHTYPE_REMOTE_SERVER The following static strings are used by the Section as values returned by the Authentication Type radio buttons.
static int	AUTHTYPE_USER
static java.lang.String	HTMLINPUT_LOGIN_NAME This response variable gets us the Login Name
static java.lang.String	HTMLINPUT_PASSWORD This response variable gets us the Password
static java.lang.String	HTMLRADIO_BASE_AUTH_TYPE This response variable gets us the Basic Auth Settings
static java.lang.String	NULL_PASSWORD This string is used in lieu of returning the actual password to the client.
static java.lang.String	STR_MVC_CLASS_NAME This object's name

Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorHelperModel

m_asOwner

Constructor Summary

BasicAuthPluginModel()

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	DoTaskBeforeWSStore() Sub models are expected to store themselves to the ptWebService object passed in in InitWSModel during this call.
void	DoTaskOnRemoteServerUpdate(java.lang.String strRemoteServerID, java.lang.String strRemoteServerName, java.lang.String strRemoteServerBaseURL) Called when the Remote Server is changed.
void	DoTaskOnWSModeUpdate(int nNewWSMode) Called when the Web Service type is changed.
int	GetAuthType() Returns the strAuthTypeRadio.
java.lang.String	GetLoginName() Returns the strLoginName.
java.lang.String	GetName() Returns the Class name.
java.lang.String	GetValidationFunction() This returns the name of the client-side validation function that the model wants added to the page-level validation funtion.
void	InitWSModel(IPTWebService ptWebService) Initializes the sub-model.
int	SaveSection(XPHashtable _htFormData) Code to save the section represented by this Model.
void	SetAuthType(int intAuthTypeRadio) Sets the strAuthTypeRadio.
void	SetLoginName(java.lang.String strLoginName) Sets the strLoginName.
void	SetPassword(java.lang.String strPassword) Sets the strPassword.

Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorHelperModel

CleanupAllData, CleanupTempData, Init

Methods inherited from class java.lang.Object

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

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

This object's name

See Also:

Constant Field Values

AUTHTYPE_REMOTE_SERVER

public static final int AUTHTYPE_REMOTE_SERVER

The following static strings are used by the Section as values returned by the Authentication Type radio buttons. The HTMLRADIO_BASE_AUTH_TYPE input must return one and only one of these strings. The value of these strings is irrelevant - they merely must be unique and URL/HTML safe.

See Also:

Constant Field Values

AUTHTYPE_USER

public static final int AUTHTYPE_USER

See Also:

Constant Field Values

AUTHTYPE_ADMIN

public static final int AUTHTYPE_ADMIN

See Also:

Constant Field Values

AUTHTYPE_LOCKBOX

public static final int AUTHTYPE_LOCKBOX

See Also:

Constant Field Values

HTMLRADIO_BASE_AUTH_TYPE

public static final java.lang.String HTMLRADIO_BASE_AUTH_TYPE

This response variable gets us the Basic Auth Settings

See Also:

Constant Field Values

HTMLINPUT_LOGIN_NAME

public static final java.lang.String HTMLINPUT_LOGIN_NAME

This response variable gets us the Login Name

See Also:

Constant Field Values

HTMLINPUT_PASSWORD

public static final java.lang.String HTMLINPUT_PASSWORD

This response variable gets us the Password

See Also:

Constant Field Values

NULL_PASSWORD

public static final java.lang.String NULL_PASSWORD

This string is used in lieu of returning the actual password to the client. If this string is unchanged - we will assume that the client has not changed the password and not reset it.

See Also:

Constant Field Values

Constructor Detail

BasicAuthPluginModel

public BasicAuthPluginModel()

Method Detail

Create

public java.lang.Object Create()

Description copied from class: EditorHelperModel

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Specified by:

Create in class EditorHelperModel

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

DoTaskBeforeWSStore

public void DoTaskBeforeWSStore()

Description copied from interface: IWSSubModel

Sub models are expected to store themselves to the ptWebService object passed in in InitWSModel during this call.

Specified by:

DoTaskBeforeWSStore in interface IWSSubModel

See Also:

IWSSubModel.DoTaskBeforeWSStore()

DoTaskOnRemoteServerUpdate

public void DoTaskOnRemoteServerUpdate(java.lang.String strRemoteServerID,
                                       java.lang.String strRemoteServerName,
                                       java.lang.String strRemoteServerBaseURL)

Description copied from interface: IWSSubModel

Called when the Remote Server is changed. This is mostly used to update the base-url displayed before URL edit boxes.

Specified by:

DoTaskOnRemoteServerUpdate in interface IWSSubModel

See Also:

IWSSubModel.DoTaskOnRemoteServerUpdate(String, String, String)

DoTaskOnWSModeUpdate

public void DoTaskOnWSModeUpdate(int nNewWSMode)

Description copied from interface: IWSSubModel

Called when the Web Service type is changed.

Specified by:

DoTaskOnWSModeUpdate in interface IWSSubModel

See Also:

IWSSubModel.DoTaskOnWSModeUpdate(int)

GetAuthType

public int GetAuthType()

Returns the strAuthTypeRadio.

Specified by:

GetAuthType in interface IBasicAuthPluginModelRO

Returns:

String

GetLoginName

public java.lang.String GetLoginName()

Returns the strLoginName. Note that there is no getter for the Password (it is never sent back to the client).

Specified by:

GetLoginName in interface IBasicAuthPluginModelRO

Returns:

String

GetName

public java.lang.String GetName()

Description copied from class: EditorHelperModel

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorHelperModel

Returns:

String

See Also:

IMVCObject.GetName()

GetValidationFunction

public java.lang.String GetValidationFunction()

Description copied from interface: IWSSubModel

This returns the name of the client-side validation function that the model wants added to the page-level validation funtion. Models return null or "" if they don't have a validation function.

Specified by:

GetValidationFunction in interface IWSSubModel

See Also:

IWSSubModel.GetValidationFunction()

InitWSModel

public void InitWSModel(IPTWebService ptWebService)

Description copied from interface: IWSSubModel

Initializes the sub-model. Provides an opportunity for the submodel to load it's state from the WebService.

Specified by:

InitWSModel in interface IWSSubModel

See Also:

com.plumtree.portalpages.admin.editors.webservice.IWSSubModel#InitWSModel()

SaveSection

public int SaveSection(XPHashtable _htFormData)

Description copied from class: EditorHelperModel

Code to save the section represented by this Model.

Specified by:

SaveSection in class EditorHelperModel

Parameters:

_htFormData - Form posted data.

Returns:

int Status for server side validation

See Also:

EditorHelperModel.SaveSection(XPHashtable)

SetAuthType

public void SetAuthType(int intAuthTypeRadio)

Sets the strAuthTypeRadio.

Parameters:

intAuthTypeRadio - The strAuthTypeRadio to set

SetLoginName

public void SetLoginName(java.lang.String strLoginName)

Sets the strLoginName.

Parameters:

strLoginName - The strLoginName to set

SetPassword

public void SetPassword(java.lang.String strPassword)

Sets the strPassword. Note that there is no getter for the Password.

Parameters:

strPassword - The strPassword to set