This repository was archived by the owner on Jul 20, 2024. It is now read-only.
forked from splunk/splunk-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDeploymentClient.java
More file actions
111 lines (99 loc) · 3.26 KB
/
DeploymentClient.java
File metadata and controls
111 lines (99 loc) · 3.26 KB
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*
* Copyright 2012 Splunk, Inc.
*
* 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 com.splunk;
/**
* The {@code DeploymentClient} class represents a Splunk deployment client,
* providing access to deployment client configuration and status.
*/
public class DeploymentClient extends Entity {
/**
* Class constructor.
*
* @param service The connected {@code Service} instance.
*/
DeploymentClient(Service service) {
super(service, "deployment/client");
}
/**
* Displays the action path.
*
* @param action The requested action.
* @return The action path.
*/
@Override protected String actionPath(String action) {
if (action.equals("edit"))
return path + "/deployment-client";
return super.actionPath(action);
}
/** Not supported for this endpoint. */
@Override public void disable() {
throw new UnsupportedOperationException();
}
/** Not supported for this endpoint. */
@Override public void enable() {
throw new UnsupportedOperationException();
}
/**
* Returns the list of server classes.
*
* @return The list of server classes, or {@code null} if not specified.
*/
public String [] getServerClasses() {
return getStringArray("serverClasses", null);
}
/**
* Returns the target URI of the deployment server for this deployment
* client.
*
* @return The target URI of the deployment server in the
* format "server:port", or {@code null} if not specified.
*/
public String getTargetUri() {
return getString("targetUri", null);
}
/**
* Reloads the deployment client from the configuration file.
*/
public void reload() {
service.get(path + "/deployment-client/Reload");
invalidate();
}
/**
* Sets whether to enable or disable the deployment client.
* <p>
* <b>Note:</b> Using this method requires you to restart Splunk before this
* setting takes effect. To avoid restarting Splunk, use the
* {@code Entity.disable} and {@code Entity.enable} methods instead, which
* take effect immediately.
* @see Entity#disable
* @see Entity#enable
*
* @param disabled {@code true} to disable the deployment client,
* {@code false} to enable it.
*/
public void setDisabled(boolean disabled) {
setCacheValue("disabled", disabled);
}
/**
* Sets the deployment server's target URI for this deployment client. The
* form of this URI is "deployment_server_uir:port".
*
* @param targetUri The target URI of the deployment server.
*/
public void setTargetUri(String targetUri) {
setCacheValue("targetUri", targetUri);
}
}