org.springframework.data.gemfire.config.annotation

Annotation Type EnableHttpService

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @Import(value=HttpServiceConfiguration.class)
 @UsesGemFireProperties
public @interface EnableHttpService

The EnableHttpService annotation marks a Spring @Configuration annotated Class to configure and enable Pivotal GemFire/Apache Geode's embedded HTTP service. By using this Annotation, this enables the embedded HTTP services like Pulse, the Management REST API and the Developer REST API on startup. However, the embedded Pivotal GemFire/Apache Geode HTTP service and all dependent services (e.g. Pulse) can be enabled/disabled externally in application.properties with the spring.data.gemfire.service.http.enabled property even when this Annotation is present, thereby serving as a toggle.

Since:

1.9.0

Author:

John Blum

See Also:

Annotation, Import, HttpServiceConfiguration, Developing REST Applications for Apache Geode

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	bindAddress If set, then the GemFire member binds the embedded HTTP service to the specified address.
int	port If non-zero, then GemFire starts an embedded HTTP service that listens on this port.
boolean	sslRequireAuthentication Boolean indicating whether to require authentication for HTTP service connections.
boolean	startDeveloperRestApi If set to true, then the Developer REST API service will be started when the cache is created.

Element Detail

bindAddress

public abstract String bindAddress

If set, then the GemFire member binds the embedded HTTP service to the specified address. If this property is not set but the HTTP service is enabled using http-service-port, then GemFire binds the HTTP service to the member’s local address. Used by the GemFire Pulse Web application and the Developer REST API service. Defaults to unset. Use the spring.data.gemfire.service.http.bind-address property in application.properties.

Default:

""

port

public abstract int port

If non-zero, then GemFire starts an embedded HTTP service that listens on this port. The HTTP service is used to host the GemFire Pulse Web application and the development REST API service. If you are hosting the Pulse web app on your own Web server and are not using the Development REST API service, then disable this embedded HTTP service by setting this property to zero. Ignored if jmx-manager and start-dev-rest-api are both set to false. Defaults to 7070. Use the spring.data.gemfire.service.http.port property in application.properties.

Default:

7070

sslRequireAuthentication

public abstract boolean sslRequireAuthentication

Boolean indicating whether to require authentication for HTTP service connections. If this property is not set, then GemFire uses the value of cluster-ssl-require-authentication to determine whether HTTP service connections require authentication. To enable SSL communications for the HTTP service, use the EnableSsl annotation and set the EnableSsl.components() to contain EnableSsl.Component.WEB. Defaults to false. Use the spring.data.gemfire.service.http.ssl-require-authentication property in application.properties.

Default:

false

startDeveloperRestApi

public abstract boolean startDeveloperRestApi

If set to true, then the Developer REST API service will be started when the cache is created. The REST service can be configured using http-service-bind-address and http-service-port Pivotal GemFire/Apache Geode System Properties. Defaults to false. Use the spring.data.gemfire.service.http.dev-rest-api.start property in application.properties.

Default:

false