jdk/src/share/classes/sun/jvmstat/monitor/MonitoredHostService.java
author sla
Tue, 01 Jul 2014 16:08:45 +0200
changeset 25183 d3ff4a191db3
permissions -rw-r--r--
8048710: Use ServiceLoader for the jvmstat protocols Reviewed-by: alanb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
25183
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
     1
/*
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
     2
 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
     4
 *
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    10
 *
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    15
 * accompanied this code).
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    16
 *
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    20
 *
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    23
 * questions.
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    24
 */
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    25
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    26
package sun.jvmstat.monitor;
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    27
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    28
public interface MonitoredHostService {
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    29
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    30
    /**
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    31
     * Construct a MonitoredHost instance to manage the
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    32
     * connection to the host indicated by <tt>hostId</tt>.
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    33
     *
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    34
     * @param hostId the identifier for the target host.
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    35
     * @return MonitoredHost - The MonitoredHost object needed to attach to
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    36
     *                         the target host.
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    37
     *
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    38
     * @throws MonitorException Thrown if monitoring errors occur.
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    39
     */
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    40
    public MonitoredHost getMonitoredHost(HostIdentifier hostId) throws MonitorException;
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    41
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    42
    /**
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    43
     * Get the scheme that this service supports.
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    44
     *
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    45
     * @return scheme name
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    46
     */
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    47
    public String getScheme();
d3ff4a191db3 8048710: Use ServiceLoader for the jvmstat protocols
sla
parents:
diff changeset
    48
}