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 pathOutputSyslog.java
More file actions
96 lines (87 loc) · 2.78 KB
/
OutputSyslog.java
File metadata and controls
96 lines (87 loc) · 2.78 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
/*
* 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 OutputSyslog} class represents a syslog output, providing access
* to properties of a forwarding server that provides data in standard syslog
* format.
*/
public class OutputSyslog extends Entity {
/**
* Class constructor.
*
* @param service The connected {@code Service} instance.
* @param path The output syslog endpoint.
*/
OutputSyslog(Service service, String path) {
super(service, path);
}
/**
* Returns the destination {@code host:port} of this server.
*
* @return The destination {@code host:port}.
*/
public String getServer() {
return getString("server");
}
/**
* Returns the connection type of this server.
*
* @return The connection type.
*/
public String getType() {
return getString("type");
}
/**
* Sets the syslog priority. For more information about the correct values
* and format, see
* <a href="http://docs.splunk.com/Documentation/Splunk/latest/Admin/Outputsconf"
* target="_blank">outputs.conf</a> in the Admin Manual.
*
* @param priority The syslog priority.
*/
public void setPriority(int priority) {
setCacheValue("priority", priority);
}
/**
* Sets the {@code host:port} where the syslog data is sent.
*
* @param server The destination {@code host:port}.
*/
public void setServer(String server) {
setCacheValue("server", server);
}
/**
* Sets the timestamp format that precedes each event that is sent. For more
* information about this format, see
* <a href="http://docs.splunk.com/Documentation/Splunk/latest/Admin/Outputsconf"
* target="_blank">outputs.conf</a> in the Admin Manual.
*
* @param timestampformat The timestamp format.
*/
public void setTimestampFormat(String timestampformat) {
setCacheValue("timestampformat", timestampformat);
}
/**
* Sets the protocol to use to send syslog data. Valid values are "tcp" and
* "udp".
*
* @param type The protocol type.
*/
public void setType(String type) {
setCacheValue("type", type);
}
}