/
EnableLocator.java
75 lines (68 loc) · 2.74 KB
/
EnableLocator.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
* Copyright 2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.springframework.data.gemfire.config.annotation;
import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.apache.geode.distributed.Locator;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
/**
* The {@link EnableLocator} annotation configures a Spring {@link Configuration @Configuration} annotated {@link Class}
* to start an embedded Pivotal GemFire/Apache Geode {@link Locator} service in this cluster member.
*
* However, the embedded Pivotal GemFire/Apache Geode Locator service can be enabled/disabled externally
* in {@literal application.properties} with the {@literal spring.data.gemfire.service.http.enabled} property
* even when this {@link Annotation} is present, thereby serving as a toggle.
*
* @author John Blum
* @see java.lang.annotation.Annotation
* @see org.springframework.context.annotation.Import
* @see org.springframework.data.gemfire.config.annotation.LocatorConfiguration
* @since 1.9.0
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Import(LocatorConfiguration.class)
@UsesGemFireProperties
@SuppressWarnings("unused")
public @interface EnableLocator {
/**
* Configures the host/IP address on which the embedded Locator service will bind to for accepting connections
* from clients sending Locator requests.
*
* Defaults to {@literal localhost}.
*
* Use the {@literal spring.data.gemfire.locator.host} property in {@literal application.properties}.
*/
String host() default LocatorConfiguration.DEFAULT_HOST;
/**
* Configures the port on which the embedded Locator service will bind to listening for client connections
* sending Locator requests.
*
* Defaults to {@literal 10334}.
*
* Use the {@literal spring.data.gemfire.locator.host} property in {@literal application.properties}.
*/
int port() default LocatorConfiguration.DEFAULT_LOCATOR_PORT;
}