File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\UDPBroadcastFragment.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson;
25
26 import jenkins.model.Jenkins;
27
28 import java.net.SocketAddress;
29
30 /**
31 * Extension point that contributes an XML fragment to the UDP broadcast.
32 *
33 * <p>
34 * Put {@link Extension} on your implementation class to have it auto-discovered.
35 *
36 * @author Kohsuke Kawaguchi
37 * @since 1.304
38 * @see UDPBroadcastThread
39 */
40 public abstract class UDPBroadcastFragment implements ExtensionPoint {
41 /**
42 * Called to build up a response XML.
43 *
44 * @param buf
45 * This is the buffer to write XML to. The implementation of this method
46 * should write a complete fragment. Because of the packet length restriction
47 * in UDP (somewhere around 1500 bytes), you cannot send a large amount of information.
48 * @param sender
49 * The socket address that sent the discovery packet out.
50 */
51 public abstract void buildFragment(StringBuilder buf, SocketAddress sender);
52
53 /**
54 * Returns all the registered {@link UDPBroadcastFragment}s.
55 */
56 public static ExtensionList<UDPBroadcastFragment> all() {
57 return Jenkins.getInstance().getExtensionList(UDPBroadcastFragment.class);
58 }
59 }
60