com.sapportals.wcm.protocol.webdav.html

Class HTMLLogin

java.lang.Object
  com.sapportals.wcm.protocol.webdav.html.HTMLLogin

All Implemented Interfaces:

IHTMLLogin

public final class HTMLLogin
extends Object
implements IHTMLLogin

Represents a HTML login form.

Copyright (c) SAP AG 2001-2004

Method Summary

com.sapportals.wcm.util.http.HttpRequest	createRequest(com.sapportals.wcm.util.http.UserInfo ui) Create a http request object suitable for sending the login form data
com.sapportals.wcm.util.uri.IHierarchicalUri	getAction() Get uri of login form action.
String	getEncType() Get encoding mime type for submitted form data.
String	getID() Get id of login form iff set.
List	getInputs() Get list of HTMLInputs of login form.
static IHTMLLogin	getInstance(IHTMLReader reader, com.sapportals.wcm.util.uri.IHierarchicalUri base, String formID) Extracts a login form from the HTML reader.
String	getMethod() Get method of login form submittal.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static IHTMLLogin getInstance(IHTMLReader reader,
                                     com.sapportals.wcm.util.uri.IHierarchicalUri base,
                                     String formID)
                              throws HTMLFormNotFoundException,
                                     HTMLException,
                                     IOException

Extracts a login form from the HTML reader. Either the id of the form is specified or the form is autodetected. In case autodetection does not work or the given form id does not exist, a HTMLFormNotFoundException is thrown.

Parameters:

reader - to read HTML form from

base - uri of html file

formID - of form to find or null for autodetection

Returns:

found HTML login form

Throws:

HTMLFormNotFoundException - when form could not be detected

HTMLException - on generic HTML errors

IOException - on errors reading the HTML

getAction

public com.sapportals.wcm.util.uri.IHierarchicalUri getAction()

Description copied from interface: IHTMLLogin

Get uri of login form action.

Specified by:

getAction in interface IHTMLLogin

Returns:

uri of form action

getEncType

public String getEncType()

Description copied from interface: IHTMLLogin

Get encoding mime type for submitted form data.

Specified by:

getEncType in interface IHTMLLogin

Returns:

encoding mime type for submitted form data

getID

public String getID()

Description copied from interface: IHTMLLogin

Get id of login form iff set. Otherwise returns null.

Specified by:

getID in interface IHTMLLogin

Returns:

id of login form

getInputs

public List getInputs()

Description copied from interface: IHTMLLogin

Get list of HTMLInputs of login form.

Specified by:

getInputs in interface IHTMLLogin

Returns:

list of HTMLInputs of login form

getMethod

public String getMethod()

Description copied from interface: IHTMLLogin

Get method of login form submittal.

Specified by:

getMethod in interface IHTMLLogin

Returns:

method of login form submittal

createRequest

public com.sapportals.wcm.util.http.HttpRequest createRequest(com.sapportals.wcm.util.http.UserInfo ui)
                                                       throws ResourceException

Description copied from interface: IHTMLLogin

Create a http request object suitable for sending the login form data

Specified by:

createRequest in interface IHTMLLogin

Parameters:

ui - username and password to use

Returns:

http request object suitable for sending the login form data

Throws:

ResourceException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM