ProxyPortletForm (WebProxyPortlet 2.3.7 API)

java.lang.Object
- org.jasig.portlet.proxy.mvc.portlet.proxy.ProxyPortletForm

```
public class ProxyPortletForm
extends Object
```
ProxyPortletForm class.

Version:

$Id: $Id

Author:

bjagg

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProxyPortletForm.ProxyAuthTypeEditor

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProxyPortletForm.ProxyAuthTypeEditor`

Field Summary

Fields
Modifier and Type Field and Description

static String AUTHENTICATION_TYPE
Constant AUTHENTICATION_TYPE="authType"

Fields
Modifier and Type	Field and Description
`static String`	`AUTHENTICATION_TYPE` Constant `AUTHENTICATION_TYPE="authType"`

Constructor Summary

Constructors
Constructor and Description

ProxyPortletForm()

Constructors
Constructor and Description
`ProxyPortletForm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAnchorWhitelistRegex()` Getter for the field `anchorWhitelistRegex`.
`org.jasig.portlet.proxy.mvc.portlet.proxy.ProxyPortletForm.ProxyAuthType`	`getAuthType()` Getter for the field `authType`.
`String`	`getBasicAuthPreferencesPassword()` Getter for the field `basicAuthPreferencesPassword`.
`String`	`getBasicAuthPreferencesUsername()` Getter for the field `basicAuthPreferencesUsername`.
`String`	`getClippingSelector()` Getter for the field `clippingSelector`.
`String`	`getContentService()` Getter for the field `contentService`.
`String`	`getFooter()` Getter for the field `footer`.
`String`	`getGsaCollection()` Getter for the field `gsaCollection`.
`String`	`getGsaFrontend()` Getter for the field `gsaFrontend`.
`String`	`getGsaHost()` Getter for the field `gsaHost`.
`String`	`getGsaWhitelistRegex()` Getter for the field `gsaWhitelistRegex`.
`String`	`getHeader()` Getter for the field `header`.
`String`	`getLocation()` Getter for the field `location`.
`String`	`getMaxLocation()` Getter for the field `maxLocation`.
`String`	`getPageCharacterEncodingFormat()` Getter for the field `pageCharacterEncodingFormat`.
`String`	`getPasswordKey()` Getter for the field `passwordKey`.
`String[]`	`getSearchStrategies()` Getter for the field `searchStrategies`.
`String`	`getUsernameKey()` Getter for the field `usernameKey`.
`String`	`getWhitelistRegexes()` Getter for the field `whitelistRegexes`.
`void`	`setAnchorWhitelistRegex(String anchorWhitelistRegex)` Setter for the field `anchorWhitelistRegex`.
`void`	`setAuthType(org.jasig.portlet.proxy.mvc.portlet.proxy.ProxyPortletForm.ProxyAuthType authType)` Setter for the field `authType`.
`void`	`setBasicAuthPreferencesPassword(String basicAuthPreferencesPassword)` Setter for the field `basicAuthPreferencesPassword`.
`void`	`setBasicAuthPreferencesUsername(String basicAuthPreferencesUsername)` Setter for the field `basicAuthPreferencesUsername`.
`void`	`setClippingSelector(String clippingSelector)` Setter for the field `clippingSelector`.
`void`	`setContentService(String contentService)` Setter for the field `contentService`.
`void`	`setFooter(String footer)` Setter for the field `footer`.
`void`	`setGsaCollection(String gsaCollection)` Setter for the field `gsaCollection`.
`void`	`setGsaFrontend(String gsaFrontend)` Setter for the field `gsaFrontend`.
`void`	`setGsaHost(String gsaHost)` Setter for the field `gsaHost`.
`void`	`setGsaWhitelistRegex(String gsaWhitelistRegex)` Setter for the field `gsaWhitelistRegex`.
`void`	`setHeader(String header)` Setter for the field `header`.
`void`	`setLocation(String location)` Setter for the field `location`.
`void`	`setMaxLocation(String maxLocation)` Setter for the field `maxLocation`.
`void`	`setPageCharacterEncodingFormat(String pageCharacterEncodingFormat)` Setter for the field `pageCharacterEncodingFormat`.
`void`	`setPasswordKey(String passwordKey)` Setter for the field `passwordKey`.
`void`	`setSearchStrategies(String[] searchStrategies)` Setter for the field `searchStrategies`.
`void`	`setUsernameKey(String usernameKey)` Setter for the field `usernameKey`.
`void`	`setWhitelistRegexes(String whitelistRegexes)` Setter for the field `whitelistRegexes`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AUTHENTICATION_TYPE
```
public static final String AUTHENTICATION_TYPE
```
    Constant AUTHENTICATION_TYPE="authType"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProxyPortletForm
```
public ProxyPortletForm()
```
- Method Detail
  - getContentService
```
public String getContentService()
```
    Getter for the field contentService.
    
    Returns:
    
    a String object
  - setContentService
```
public void setContentService(String contentService)
```
    Setter for the field contentService.
    
    Parameters:
    
    contentService - a String object
  - getLocation
```
public String getLocation()
```
    Getter for the field location.
    
    Returns:
    
    a String object
  - setLocation
```
public void setLocation(String location)
```
    Setter for the field location.
    
    Parameters:
    
    location - a String object
  - getMaxLocation
```
public String getMaxLocation()
```
    Getter for the field maxLocation.
    
    Returns:
    
    a String object
  - setMaxLocation
```
public void setMaxLocation(String maxLocation)
```
    Setter for the field maxLocation.
    
    Parameters:
    
    maxLocation - a String object
  - getClippingSelector
```
public String getClippingSelector()
```
    Getter for the field clippingSelector.
    
    Returns:
    
    a String object
  - getWhitelistRegexes
```
public String getWhitelistRegexes()
```
    Getter for the field whitelistRegexes.
    
    Returns:
    
    a String object
  - setWhitelistRegexes
```
public void setWhitelistRegexes(String whitelistRegexes)
```
    Setter for the field whitelistRegexes.
    
    Parameters:
    
    whitelistRegexes - a String object
  - setClippingSelector
```
public void setClippingSelector(String clippingSelector)
```
    Setter for the field clippingSelector.
    
    Parameters:
    
    clippingSelector - a String object
  - getHeader
```
public String getHeader()
```
    Getter for the field header.
    
    Returns:
    
    a String object
  - setHeader
```
public void setHeader(String header)
```
    Setter for the field header.
    
    Parameters:
    
    header - a String object
  - getFooter
```
public String getFooter()
```
    Getter for the field footer.
    
    Returns:
    
    a String object
  - setFooter
```
public void setFooter(String footer)
```
    Setter for the field footer.
    
    Parameters:
    
    footer - a String object
  - getAuthType
```
public org.jasig.portlet.proxy.mvc.portlet.proxy.ProxyPortletForm.ProxyAuthType getAuthType()
```
    Getter for the field authType.
    
    Returns:
    
    a ProxyPortletForm.ProxyAuthType object
  - setAuthType
```
public void setAuthType(org.jasig.portlet.proxy.mvc.portlet.proxy.ProxyPortletForm.ProxyAuthType authType)
```
    Setter for the field authType.
    
    Parameters:
    
    authType - a ProxyPortletForm.ProxyAuthType object
  - getUsernameKey
```
public String getUsernameKey()
```
    Getter for the field usernameKey.
    
    Returns:
    
    a String object
  - setUsernameKey
```
public void setUsernameKey(String usernameKey)
```
    Setter for the field usernameKey.
    
    Parameters:
    
    usernameKey - a String object
  - getPasswordKey
```
public String getPasswordKey()
```
    Getter for the field passwordKey.
    
    Returns:
    
    a String object
  - setPasswordKey
```
public void setPasswordKey(String passwordKey)
```
    Setter for the field passwordKey.
    
    Parameters:
    
    passwordKey - a String object
  - getBasicAuthPreferencesUsername
```
public String getBasicAuthPreferencesUsername()
```
    Getter for the field basicAuthPreferencesUsername.
    
    Returns:
    
    a String object
  - setBasicAuthPreferencesUsername
```
public void setBasicAuthPreferencesUsername(String basicAuthPreferencesUsername)
```
    Setter for the field basicAuthPreferencesUsername.
    
    Parameters:
    
    basicAuthPreferencesUsername - a String object
  - getBasicAuthPreferencesPassword
```
public String getBasicAuthPreferencesPassword()
```
    Getter for the field basicAuthPreferencesPassword.
    
    Returns:
    
    a String object
  - setBasicAuthPreferencesPassword
```
public void setBasicAuthPreferencesPassword(String basicAuthPreferencesPassword)
```
    Setter for the field basicAuthPreferencesPassword.
    
    Parameters:
    
    basicAuthPreferencesPassword - a String object
  - getPageCharacterEncodingFormat
```
public String getPageCharacterEncodingFormat()
```
    Getter for the field pageCharacterEncodingFormat.
    
    Returns:
    
    a String object
  - setPageCharacterEncodingFormat
```
public void setPageCharacterEncodingFormat(String pageCharacterEncodingFormat)
```
    Setter for the field pageCharacterEncodingFormat.
    
    Parameters:
    
    pageCharacterEncodingFormat - a String object
  - getGsaHost
```
public String getGsaHost()
```
    Getter for the field gsaHost.
    
    Returns:
    
    a String object
  - setGsaHost
```
public void setGsaHost(String gsaHost)
```
    Setter for the field gsaHost.
    
    Parameters:
    
    gsaHost - a String object
  - getGsaCollection
```
public String getGsaCollection()
```
    Getter for the field gsaCollection.
    
    Returns:
    
    a String object
  - setGsaCollection
```
public void setGsaCollection(String gsaCollection)
```
    Setter for the field gsaCollection.
    
    Parameters:
    
    gsaCollection - a String object
  - getGsaFrontend
```
public String getGsaFrontend()
```
    Getter for the field gsaFrontend.
    
    Returns:
    
    a String object
  - setGsaFrontend
```
public void setGsaFrontend(String gsaFrontend)
```
    Setter for the field gsaFrontend.
    
    Parameters:
    
    gsaFrontend - a String object
  - getSearchStrategies
```
public String[] getSearchStrategies()
```
    Getter for the field searchStrategies.
    
    Returns:
    
    an array of String objects
  - setSearchStrategies
```
public void setSearchStrategies(String[] searchStrategies)
```
    Setter for the field searchStrategies.
    
    Parameters:
    
    searchStrategies - an array of String objects
  - getGsaWhitelistRegex
```
public String getGsaWhitelistRegex()
```
    Getter for the field gsaWhitelistRegex.
    
    Returns:
    
    a String object
  - setGsaWhitelistRegex
```
public void setGsaWhitelistRegex(String gsaWhitelistRegex)
```
    Setter for the field gsaWhitelistRegex.
    
    Parameters:
    
    gsaWhitelistRegex - a String object
  - getAnchorWhitelistRegex
```
public String getAnchorWhitelistRegex()
```
    Getter for the field anchorWhitelistRegex.
    
    Returns:
    
    a String object
  - setAnchorWhitelistRegex
```
public void setAnchorWhitelistRegex(String anchorWhitelistRegex)
```
    Setter for the field anchorWhitelistRegex.
    
    Parameters:
    
    anchorWhitelistRegex - a String object

Class ProxyPortletForm

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AUTHENTICATION_TYPE

Constructor Detail

ProxyPortletForm

Method Detail

getContentService

setContentService

getLocation

setLocation

getMaxLocation

setMaxLocation

getClippingSelector

getWhitelistRegexes

setWhitelistRegexes

setClippingSelector

getHeader

setHeader

getFooter

setFooter

getAuthType

setAuthType

getUsernameKey

setUsernameKey

getPasswordKey

setPasswordKey

getBasicAuthPreferencesUsername

setBasicAuthPreferencesUsername

getBasicAuthPreferencesPassword

setBasicAuthPreferencesPassword

getPageCharacterEncodingFormat

setPageCharacterEncodingFormat

getGsaHost

setGsaHost

getGsaCollection

setGsaCollection

getGsaFrontend

setGsaFrontend

getSearchStrategies

setSearchStrategies

getGsaWhitelistRegex

setGsaWhitelistRegex

getAnchorWhitelistRegex

setAnchorWhitelistRegex