Page (OpenNMS 2021.1.1 API)

java.lang.Object
- org.opennms.netmgt.config.pagesequence.Page

All Implemented Interfaces:

Serializable
```
public class Page
extends Object
implements Serializable
```
This element specifies all the possible attributes in as fine grained detail as possible. All that is really required (as you can see below) is the "path" attribute. From that one attribute, the IP address passed in through the ServiceMonitor and ServiceCollector interface, the URL will be fully generated using the supplied defaults in this config. Configure attributes these attributes to the level of detail you need to fully control the behavior.

A little bit of indirection is possible here with the host attribute. If the host attribute is anything other than the default, that value will be used instead of the IP address passed in through the API (Interface).

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Page()

Constructors
Constructor and Description
`Page()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHeader(Header header)`
`void`	`addParameter(Parameter parameter)`
`void`	`addSessionVariable(SessionVariable sessionVariable)`
`boolean`	`equals(Object obj)`
`String`	`getDisableSslVerification()` This element is used to enable or disable SSL host and certificate verification.
`String`	`getDsName()`
`String`	`getFailureMatch()`
`String`	`getFailureMessage()`
`String`	`getFragment()`
`List<Header>`	`getHeaders()`
`String`	`getHost()`
`String`	`getHttpVersion()`
`String`	`getLocationMatch()`
`String`	`getMethod()`
`List<Parameter>`	`getParameters()`
`String`	`getPath()`
`Integer`	`getPort()`
`String`	`getQuery()`
`Boolean`	`getRequireIPv4()`
`Boolean`	`getRequireIPv6()`
`String`	`getResponseRange()`
`String`	`getScheme()`
`List<SessionVariable>`	`getSessionVariables()`
`String`	`getSuccessMatch()`
`String`	`getUserAgent()`
`String`	`getUserInfo()`
`String`	`getVirtualHost()`
`int`	`hashCode()`
`boolean`	`isRequireIPv4()`
`boolean`	`isRequireIPv6()`
`boolean`	`removeHeader(Header header)`
`boolean`	`removeParameter(Parameter parameter)`
`boolean`	`removeSessionVariable(SessionVariable sessionVariable)`
`void`	`setDisableSslVerification(String disableSslVerification)`
`void`	`setDsName(String dsName)`
`void`	`setFailureMatch(String failureMatch)`
`void`	`setFailureMessage(String failureMessage)`
`void`	`setFragment(String fragment)`
`void`	`setHeaders(List<Header> headers)`
`void`	`setHost(String host)`
`void`	`setHttpVersion(String httpVersion)`
`void`	`setLocationMatch(String locationMatch)`
`void`	`setMethod(String method)`
`void`	`setParameters(List<Parameter> parameters)`
`void`	`setPath(String path)`
`void`	`setPort(Integer port)`
`void`	`setQuery(String query)`
`void`	`setRequireIPv4(Boolean requireIPv4)`
`void`	`setRequireIPv6(Boolean requireIPv6)`
`void`	`setResponseRange(String responseRange)`
`void`	`setScheme(String scheme)`
`void`	`setSessionVariables(List<SessionVariable> sessionVariables)`
`void`	`setSuccessMatch(String successMatch)`
`void`	`setUserAgent(String userAgent)`
`void`	`setUserInfo(String userInfo)`
`void`	`setVirtualHost(String virtualHost)`
`String`	`toString()`

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

Constructor Detail
- Page
```
public Page()
```

Method Detail

getMethod
```
public String getMethod()
```

setMethod
```
public void setMethod(String method)
```

getHttpVersion
```
public String getHttpVersion()
```

setHttpVersion

public void setHttpVersion(String httpVersion)

getUserAgent
```
public String getUserAgent()
```

setUserAgent

public void setUserAgent(String userAgent)

getVirtualHost
```
public String getVirtualHost()
```

setVirtualHost

public void setVirtualHost(String virtualHost)

getScheme
```
public String getScheme()
```

setScheme
```
public void setScheme(String scheme)
```

getUserInfo
```
public String getUserInfo()
```

setUserInfo

public void setUserInfo(String userInfo)

getHost
```
public String getHost()
```

setHost
```
public void setHost(String host)
```

getRequireIPv4
```
public Boolean getRequireIPv4()
```

isRequireIPv4
```
public boolean isRequireIPv4()
```

setRequireIPv4

public void setRequireIPv4(Boolean requireIPv4)

getRequireIPv6
```
public Boolean getRequireIPv6()
```

isRequireIPv6
```
public boolean isRequireIPv6()
```

setRequireIPv6

public void setRequireIPv6(Boolean requireIPv6)

getDisableSslVerification
```
public String getDisableSslVerification()
```
This element is used to enable or disable SSL host and certificate verification. Default: true (verification is disabled)

setDisableSslVerification

public void setDisableSslVerification(String disableSslVerification)

getPort
```
public Integer getPort()
```

setPort
```
public void setPort(Integer port)
```

getPath
```
public String getPath()
```

setPath
```
public void setPath(String path)
```

getQuery
```
public String getQuery()
```

setQuery
```
public void setQuery(String query)
```

getFragment
```
public String getFragment()
```

setFragment

public void setFragment(String fragment)

getFailureMatch
```
public String getFailureMatch()
```

setFailureMatch

public void setFailureMatch(String failureMatch)

getFailureMessage
```
public String getFailureMessage()
```

setFailureMessage

public void setFailureMessage(String failureMessage)

getSuccessMatch
```
public String getSuccessMatch()
```

setSuccessMatch

public void setSuccessMatch(String successMatch)

getLocationMatch
```
public String getLocationMatch()
```

setLocationMatch

public void setLocationMatch(String locationMatch)

getResponseRange
```
public String getResponseRange()
```

setResponseRange

public void setResponseRange(String responseRange)

getDsName
```
public String getDsName()
```

setDsName
```
public void setDsName(String dsName)
```

getParameters

public List<Parameter> getParameters()

setParameters

public void setParameters(List<Parameter> parameters)

addParameter

public void addParameter(Parameter parameter)
                  throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

removeParameter

public boolean removeParameter(Parameter parameter)

getHeaders
```
public List<Header> getHeaders()
```

setHeaders

public void setHeaders(List<Header> headers)

addHeader
```
public void addHeader(Header header)
```

removeHeader

public boolean removeHeader(Header header)

getSessionVariables

public List<SessionVariable> getSessionVariables()

setSessionVariables

public void setSessionVariables(List<SessionVariable> sessionVariables)

addSessionVariable

public void addSessionVariable(SessionVariable sessionVariable)
                        throws IndexOutOfBoundsException

Throws:: IndexOutOfBoundsException

removeSessionVariable

public boolean removeSessionVariable(SessionVariable sessionVariable)

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class Page

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Page

Method Detail

getMethod

setMethod

getHttpVersion

setHttpVersion

getUserAgent

setUserAgent

getVirtualHost

setVirtualHost

getScheme

setScheme

getUserInfo

setUserInfo

getHost

setHost

getRequireIPv4

isRequireIPv4

setRequireIPv4

getRequireIPv6

isRequireIPv6

setRequireIPv6

getDisableSslVerification

setDisableSslVerification

getPort

setPort

getPath

setPath

getQuery

setQuery

getFragment

setFragment

getFailureMatch

setFailureMatch

getFailureMessage

setFailureMessage

getSuccessMatch

setSuccessMatch

getLocationMatch

setLocationMatch

getResponseRange

setResponseRange

getDsName

setDsName

getParameters

setParameters

addParameter

removeParameter

getHeaders

setHeaders

addHeader

removeHeader

getSessionVariables

setSessionVariables

addSessionVariable

removeSessionVariable

hashCode

equals

toString