Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(jfrconnection): refactor interface to allow other impls #171

Merged
merged 1 commit into from
Jan 3, 2023
Merged

chore(jfrconnection): refactor interface to allow other impls #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions src/main/java/io/cryostat/core/net/IDException.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
/*
* Copyright The Cryostat Authors
*
* The Universal Permissive License (UPL), Version 1.0
*
* Subject to the condition set forth below, permission is hereby granted to any
* person obtaining a copy of this software, associated documentation and/or data
* (collectively the "Software"), free of charge and under any and all copyright
* rights in the Software, and any and all patent rights owned or freely
* licensable by each licensor hereunder covering either (i) the unmodified
* Software as contributed to or provided by such licensor, or (ii) the Larger
* Works (as defined below), to deal in both
*
* (a) the Software, and
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
* one is included with the Software (each a "Larger Work" to which the Software
* is contributed by such licensors),
*
* without restriction, including without limitation the rights to copy, create
* derivative works of, display, perform, and distribute the Software and make,
* use, sell, offer for sale, import, export, have made, and have sold the
* Software and the Larger Work(s), and to sublicense the foregoing rights on
* either these or other terms.
*
* This license is subject to the following condition:
* The above copyright notice and either this complete permission notice or at
* a minimum a reference to the UPL must be included in all copies or
* substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package io.cryostat.core.net;

import java.io.IOException;

public class IDException extends IOException {

public IDException(Throwable cause) {
super(cause);
}
}
280 changes: 13 additions & 267 deletions src/main/java/io/cryostat/core/net/JFRConnection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,294 +37,40 @@
*/
package io.cryostat.core.net;

import java.io.ByteArrayOutputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Base64;
import java.util.List;
import java.util.stream.Collectors;

import javax.management.AttributeNotFoundException;
import javax.management.InstanceNotFoundException;
import javax.management.MBeanException;
import javax.management.ReflectionException;
import javax.management.remote.JMXServiceURL;

import org.openjdk.jmc.rjmx.ConnectionException;
import org.openjdk.jmc.rjmx.ConnectionToolkit;
import org.openjdk.jmc.rjmx.IConnectionDescriptor;
import org.openjdk.jmc.rjmx.IConnectionHandle;
import org.openjdk.jmc.rjmx.IConnectionListener;
import org.openjdk.jmc.rjmx.ServiceNotAvailableException;
import org.openjdk.jmc.rjmx.internal.DefaultConnectionHandle;
import org.openjdk.jmc.rjmx.internal.RJMXConnection;
import org.openjdk.jmc.rjmx.internal.ServerDescriptor;
import org.openjdk.jmc.rjmx.services.jfr.IFlightRecorderService;
import org.openjdk.jmc.rjmx.services.jfr.internal.FlightRecorderServiceFactory;
import org.openjdk.jmc.rjmx.services.jfr.internal.FlightRecorderServiceV2;
import org.openjdk.jmc.rjmx.subscription.MRI;
import org.openjdk.jmc.rjmx.subscription.MRI.Type;

import io.cryostat.core.sys.Clock;
import io.cryostat.core.sys.Environment;
import io.cryostat.core.sys.FileSystem;
import io.cryostat.core.templates.MergedTemplateService;
import io.cryostat.core.templates.TemplateService;
import io.cryostat.core.tui.ClientWriter;

import org.apache.commons.codec.digest.DigestUtils;
public interface JFRConnection extends AutoCloseable {

public class JFRConnection implements AutoCloseable {
public IConnectionHandle getHandle() throws ConnectionException, IOException;

public static final int DEFAULT_PORT = 9091;
public IFlightRecorderService getService()
throws ConnectionException, IOException, ServiceNotAvailableException;

protected final ClientWriter cw;
protected final FileSystem fs;
protected final Environment env;
protected final FlightRecorderServiceFactory serviceFactory;
protected final List<Runnable> closeListeners;
protected RJMXConnection rjmxConnection;
protected IConnectionHandle handle;
protected IConnectionDescriptor connectionDescriptor;
public TemplateService getTemplateService();

JFRConnection(
ClientWriter cw,
FileSystem fs,
Environment env,
IConnectionDescriptor cd,
List<Runnable> listeners)
throws ConnectionException {
this.cw = cw;
this.fs = fs;
this.env = env;
this.connectionDescriptor = cd;
this.closeListeners = new ArrayList<>(listeners);
this.serviceFactory = new FlightRecorderServiceFactory();
}
public long getApproximateServerTime(Clock clock);

JFRConnection(ClientWriter cw, FileSystem fs, Environment env, IConnectionDescriptor cd)
throws ConnectionException {
this(cw, fs, env, cd, List.of());
}
public JMXServiceURL getJMXURL() throws IOException;

public synchronized IConnectionHandle getHandle() throws ConnectionException, IOException {
if (!isConnected()) {
connect();
}
IConnectionHandle handle = this.handle;
if (handle == null || !isConnected()) {
throw new ConnectionException(
String.format(
"Could not connect to remote target %s",
this.connectionDescriptor.createJMXServiceURL().toString()));
}
return handle;
}
public String getHost();

public synchronized IFlightRecorderService getService()
throws ConnectionException, IOException, ServiceNotAvailableException {
if (!isConnected()) {
connect();
}
IFlightRecorderService service = serviceFactory.getServiceInstance(handle);
if (service == null || !isConnected()) {
throw new ConnectionException(
String.format(
"Could not connect to remote target %s",
this.connectionDescriptor.createJMXServiceURL().toString()));
}
return service;
}
public int getPort();

public TemplateService getTemplateService() {
return new MergedTemplateService(this, fs, env);
}
public String getJvmId() throws IDException, IOException;

public synchronized long getApproximateServerTime(Clock clock) {
return this.rjmxConnection.getApproximateServerTime(clock.getWallTime());
}
public boolean isConnected();

public synchronized JMXServiceURL getJMXURL() throws IOException {
return this.connectionDescriptor.createJMXServiceURL();
}
public void connect() throws ConnectionException;

public synchronized String getHost() {
try {
return ConnectionToolkit.getHostName(
this.rjmxConnection.getConnectionDescriptor().createJMXServiceURL());
} catch (IOException e) {
cw.println(e);
return "unknown";
}
}

public synchronized int getPort() {
try {
return ConnectionToolkit.getPort(
this.rjmxConnection.getConnectionDescriptor().createJMXServiceURL());
} catch (IOException e) {
cw.println(e);
return 0;
}
}

public synchronized String getJvmId()
throws AttributeNotFoundException, InstanceNotFoundException, MBeanException,
ReflectionException, IOException {
if (!isConnected()) {
connect();
}
List<String> attrNames =
new ArrayList<>(
Arrays.asList(
"ClassPath",
"Name",
"InputArguments",
"LibraryPath",
"VmVendor",
"VmVersion",
"StartTime"));

try (ByteArrayOutputStream baos = new ByteArrayOutputStream(512);
DataOutputStream dos = new DataOutputStream(baos)) {
for (String attr : attrNames) {
Object attrObject =
this.rjmxConnection.getAttributeValue(
new MRI(Type.ATTRIBUTE, ConnectionToolkit.RUNTIME_BEAN_NAME, attr));
if (attrObject.getClass().isArray()) {
String stringified = stringifyArray(attrObject);
dos.writeUTF(stringified);
} else {
dos.writeUTF(attrObject.toString());
}
}
byte[] hash = DigestUtils.sha256(baos.toByteArray());
return new String(Base64.getUrlEncoder().encode(hash), StandardCharsets.UTF_8).trim();
}
}

private String stringifyArray(Object arrayObject) {
String stringified;
String componentType = arrayObject.getClass().getComponentType().toString();
switch (componentType) {
case "boolean":
stringified = Arrays.toString((boolean[]) arrayObject);
break;

case "byte":
stringified = Arrays.toString((byte[]) arrayObject);
break;

case "char":
stringified = Arrays.toString((char[]) arrayObject);
break;

case "short":
stringified = Arrays.toString((short[]) arrayObject);
break;

case "int":
stringified = Arrays.toString((int[]) arrayObject);
break;

case "long":
stringified = Arrays.toString((long[]) arrayObject);
break;

case "float":
stringified = Arrays.toString((float[]) arrayObject);
break;

case "double":
stringified = Arrays.toString((double[]) arrayObject);
break;

default:
stringified = Arrays.toString((Object[]) arrayObject);
}
return stringified;
}

public synchronized boolean isV1() {
return !isV2();
}

public synchronized boolean isV2() {
return FlightRecorderServiceV2.isAvailable(this.handle);
}

public synchronized boolean isConnected() {
return this.rjmxConnection != null && this.rjmxConnection.isConnected();
}

public synchronized void connect() throws ConnectionException {
if (isConnected()) {
return;
}
this.rjmxConnection = attemptConnect(connectionDescriptor);
this.handle =
new DefaultConnectionHandle(
rjmxConnection,
"RJMX Connection",
closeListeners.stream()
.map(
l ->
new IConnectionListener() {
@Override
public void onConnectionChange(
IConnectionHandle arg0) {
l.run();
}
})
.collect(Collectors.toList())
.toArray(new IConnectionListener[0]));
}

public synchronized void disconnect() {
try {
if (this.handle != null) {
this.handle.close();
}
} catch (IOException e) {
cw.println(e);
} finally {
if (this.rjmxConnection != null) {
this.rjmxConnection.close();
}
}
}

@Override
public synchronized void close() {
this.disconnect();
}

protected synchronized RJMXConnection attemptConnect(IConnectionDescriptor cd)
throws ConnectionException {
try {
RJMXConnection conn =
new RJMXConnection(cd, new ServerDescriptor(), JFRConnection::failConnection);
if (!conn.connect()) {
failConnection();
}
return conn;
} catch (ConnectionException e) {
cw.println("connection attempt failed.");
closeListeners.forEach(Runnable::run);
throw e;
}
}

protected static void failConnection() {
throw new ConnectionFailureException("Connection Failed");
}

static class ConnectionFailureException extends RuntimeException {
public ConnectionFailureException(String message) {
super(message);
}
}
public void disconnect();
}
2 changes: 1 addition & 1 deletion src/main/java/io/cryostat/core/net/JFRConnectionToolkit.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public JFRConnection connect(
.username(credentials.getUsername())
.password(credentials.getPassword());
}
return new JFRConnection(cw, fs, env, connectionDescriptorBuilder.build(), listeners);
return new JFRJMXConnection(cw, fs, env, connectionDescriptorBuilder.build(), listeners);
}

public String getHostName(JMXServiceURL url) {
Expand Down
Loading