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

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

All Implemented Interfaces:

IWSSubModel, IFormLoginPluginModelRO, IManagedObject, IModel, IModelRO, IMVCObject

public class FormLoginPluginModel
extends EditorHelperModel
implements IFormLoginPluginModelRO, IWSSubModel

Author:

akashj

Field Summary

static int	CREDENTIAL_TYPE_LOCKBOX_AUTH
static int	CREDENTIAL_TYPE_NONE constants
static int	CREDENTIAL_TYPE_PORTAL_AUTH
static java.lang.String	HTMLINPUT_LOGINURL URLs - login and post
static java.lang.String	HTMLINPUT_PASSWORD_FIELD_NAME
static java.lang.String	HTMLINPUT_POSTURL
static java.lang.String	HTMLINPUT_USERNAME_FIELD_NAME Form Fields - username and password
static java.lang.String	HTMLRADIO_CREDENTIAL_TYPE Radio - credential type to be sent (see constants below)
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

FormLoginPluginModel()

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	GetCredentialType() Returns a series of constants representing the type of credential to send.
java.lang.String	GetLoginURL() The URL to that identifies a login URL - this can be a pattern with '*' characters to do wildcard matches.
java.lang.String	GetName() Returns the Class name.
java.lang.String	GetPasswordFieldName() Returns the HTML field to send the password as to the POST URL.
java.lang.String	GetPostURL() The URL that credentials should be POSTed to.
java.lang.String	GetUsernameFieldName() Returns the HTML field to send the username as to the POST URL.
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.

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

HTMLINPUT_LOGINURL

public static final java.lang.String HTMLINPUT_LOGINURL

URLs - login and post

See Also:

Constant Field Values

HTMLINPUT_POSTURL

public static final java.lang.String HTMLINPUT_POSTURL

See Also:

Constant Field Values

HTMLINPUT_USERNAME_FIELD_NAME

public static final java.lang.String HTMLINPUT_USERNAME_FIELD_NAME

Form Fields - username and password

See Also:

Constant Field Values

HTMLINPUT_PASSWORD_FIELD_NAME

public static final java.lang.String HTMLINPUT_PASSWORD_FIELD_NAME

See Also:

Constant Field Values

HTMLRADIO_CREDENTIAL_TYPE

public static final java.lang.String HTMLRADIO_CREDENTIAL_TYPE

Radio - credential type to be sent (see constants below)

See Also:

Constant Field Values

CREDENTIAL_TYPE_NONE

public static final int CREDENTIAL_TYPE_NONE

constants

See Also:

Constant Field Values

CREDENTIAL_TYPE_PORTAL_AUTH

public static final int CREDENTIAL_TYPE_PORTAL_AUTH

See Also:

Constant Field Values

CREDENTIAL_TYPE_LOCKBOX_AUTH

public static final int CREDENTIAL_TYPE_LOCKBOX_AUTH

See Also:

Constant Field Values

Constructor Detail

FormLoginPluginModel

public FormLoginPluginModel()

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)

GetLoginURL

public java.lang.String GetLoginURL()

Description copied from interface: IFormLoginPluginModelRO

The URL to that identifies a login URL - this can be a pattern with '*' characters to do wildcard matches.

Specified by:

GetLoginURL in interface IFormLoginPluginModelRO

Returns:

the login URL as a String

GetPostURL

public java.lang.String GetPostURL()

Description copied from interface: IFormLoginPluginModelRO

The URL that credentials should be POSTed to.

Specified by:

GetPostURL in interface IFormLoginPluginModelRO

Returns:

the POST URL as a String

GetCredentialType

public int GetCredentialType()

Description copied from interface: IFormLoginPluginModelRO

Returns a series of constants representing the type of credential to send. The choices are: 0 - none (relies on the form fields only) 1 - Portal Username/Password 2 - Lockbox Username/Password

Specified by:

GetCredentialType in interface IFormLoginPluginModelRO

Returns:

the credential type as an int

GetPasswordFieldName

public java.lang.String GetPasswordFieldName()

Description copied from interface: IFormLoginPluginModelRO

Returns the HTML field to send the password as to the POST URL.

Specified by:

GetPasswordFieldName in interface IFormLoginPluginModelRO

Returns:

the password field name as a String

GetUsernameFieldName

public java.lang.String GetUsernameFieldName()

Description copied from interface: IFormLoginPluginModelRO

Returns the HTML field to send the username as to the POST URL.

Specified by:

GetUsernameFieldName in interface IFormLoginPluginModelRO

Returns:

the username field name as a 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)