com.google.enterprise.connector.spi

Class ConfigureResponse

java.lang.Object

com.google.enterprise.connector.spi.ConfigureResponse

public class ConfigureResponse
extends java.lang.Object

The response for most configuration methods, such as ConnectorType.getConfigForm and ConnectorType.validateConfig.

Since:

1.0

See Also:

ConnectorType

Constructor Summary

Constructors

Constructor and Description
ConfigureResponse(java.lang.String message, java.lang.String formSnippet) Simple constructor.
ConfigureResponse(java.lang.String message, java.lang.String formSnippet, java.util.Map<java.lang.String,java.lang.String> configData) Complete constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getConfigData() Gets the config data.
java.lang.String	getFormSnippet() Gets the form snippet.
java.lang.String	getMessage() Gets the message.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigureResponse

public ConfigureResponse(java.lang.String message,
                         java.lang.String formSnippet)

Simple constructor.

Parameters:

message - A message to be included to the user along with the form. This message may be null or empty - no distinction is made between those cases. The message should be plain text - may not contain script directives.

formSnippet - A well formed snippet of XHTML containing a sequence of <tr> elements to be displayed within a form. Each <tr> should contain two <td> fields. First is the description of configuration element, and second is the form element. The snippet may be null or empty. Script elements should be avoided, however, if they are used the script code must be contained within a CDATA section.

ConfigureResponse

public ConfigureResponse(java.lang.String message,
                         java.lang.String formSnippet,
                         java.util.Map<java.lang.String,java.lang.String> configData)

Complete constructor.

Parameters:

message - A message to be included to the user along with the form. This message may be null or empty - no distinction is made between those cases. The message should be plain text - may not contain script directives.

formSnippet - A well formed snippet of XHTML containing a sequence of <tr> elements to be displayed within a form. Each <tr> should contain two <td> fields. First is the description of configuration element, and second is the form element. The snippet may be null or empty. Script elements should be avoided, however, if they are used the script code must be contained within a CDATA section.

configData - A Map of name, value pairs (String, String) of configuration data. If supplied, where appropriate, the Connector Manager will use this data.

Method Detail

getMessage

public java.lang.String getMessage()

Gets the message.

Returns:

the message - may be null or empty

getFormSnippet

public java.lang.String getFormSnippet()

Gets the form snippet.

Returns:

the form snippet - may be null or empty

getConfigData

public java.util.Map<java.lang.String,java.lang.String> getConfigData()

Gets the config data.

Returns:

the config data - may be null or empty