blob: fc0e3fece3670706967256aaeca99c54bfb21499 (
plain)
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
|
/**
* This class specifies all methods common to syslog senders. It also implements
* some generic ways to send data. Actual syslog senders (e.g. UDP, TCP, ...) shall
* be derived from this class.
*
* This is a limited-capability implementation of a syslog message together
* with all its properties. It is limit to what is currently needed and may
* be extended as further need arises.
*
* @author Rainer Gerhards
*
* Copyright 2009 Rainer Gerhards and Adiscon GmbH.
*
* This file is part of rsyslog.
*
* Rsyslog is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Rsyslog is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Rsyslog. If not, see http://www.gnu.org/licenses/.
*
* A copy of the GPL can be found in the file "COPYING" in this distribution.
*/
package com.rsyslog.lib;
public abstract class SyslogSender {
/** the rawmsg without the PRI part */
private String target;
/** the rawmsg without the PRI part */
private boolean isConnected = false;
/** Constructs Sender, sets target system.
* @param target the system to connect to. Syntax of target is depending
* on the underlying transport.
*/
public SyslogSender(String target) {
this.target = target;
}
/** send a message on the wire.
* This needs a complete formatted message, which will be extended by
* the transport framing, if necessary.
*
* @param MSG a validly formatted syslog message as of the RFC (all parts)
* @throws Exception (depending on transport)
*/
protected abstract void sendTransport(String MSG) throws Exception;
/** send an alread-formatted message.
* Sends a preformatted syslog message payload to the target. Connects
* to the target if not already connected.
*
* @param MSG a validly formatted syslog message as of the RFC (all parts)
* @throws Exception (depending on transport)
*/
public void sendMSG(String MSG) throws Exception {
if(!isConnected)
connect();
sendTransport(MSG);
}
/** connect to the target.
* Note that this may be a null operation if there is no session-like entity
* in the underlying transport (as is for example in UDP).
*/
public void connect() throws Exception {
/* the default implementation does (almost) nothing */
isConnected = true;
}
/** disconnects from the target.
* Note that this may be a null operation if there is no session-like entity
* in the underlying transport (as is for example in UDP).
*/
public void disconnect() {
/* the default implementation does (almost) nothing */
isConnected = false;
}
/** return target of this Sender.
* @returns target as initially set
*/
public String getTarget() {
return target;
}
}
|
