org.jboss.remoting3.ClientServiceHandle Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
The newest version!
/*
* JBoss, Home of Professional Open Source.
* Copyright 2017 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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 org.jboss.remoting3;
import static org.xnio.IoUtils.safeClose;
import java.io.IOException;
import java.util.function.Function;
import org.xnio.FinishedIoFuture;
import org.xnio.FutureResult;
import org.xnio.IoFuture;
import org.xnio.OptionMap;
import static org.jboss.remoting3._private.Messages.log;
/**
* A handle for helping service protocol providers to create and maintain a single channel per connection.
*
* @author David M. Lloyd
*/
public final class ClientServiceHandle {
private final Attachments.Key> key;
private final String serviceName;
private final Function> constructor;
private Channel channel;
/**
* Construct a new instance. Only one instance should be constructed per service; instances may be safely
* cached in {@code static} fields.
*
* @param serviceName the service name (may not be {@code null})
* @param constructor the service future construction operation
*/
@SuppressWarnings("unchecked")
public ClientServiceHandle(final String serviceName, final Function> constructor) {
log.tracef("Creating ClientServiceHandle for service '%s': %s", serviceName, this);
key = (Attachments.Key>) (Object) new Attachments.Key<>(IoFuture.class);
this.serviceName = serviceName;
this.constructor = constructor;
}
/**
* Get or establish the future client service for the given connection.
*
* @param connection the connection
* @param optionMap the service options
* @return the future service instance
*/
public IoFuture getClientService(final Connection connection, OptionMap optionMap) {
final Attachments attachments = connection.getAttachments();
// check for prior
IoFuture existing = attachments.getAttachment(key);
if (existing != null) {
log.tracef("ClientServiceHandle %s ('%s') found existing service at connection %s", this, serviceName, connection);
return existing;
}
// create new future result, try to attach it
final FutureResult futureResult = new FutureResult<>(connection.getEndpoint().getXnioWorker());
final IoFuture future = futureResult.getIoFuture();
existing = attachments.attachIfAbsent(key, future);
if (existing != null) {
log.tracef("ClientServiceHandle %s ('%s') found existing service at connection %s", this, serviceName, connection);
return existing;
}
log.tracef("ClientServiceHandle %s ('%s') constructing future service at connection %s", this, serviceName, connection);
// open the channel and create notifiers to trigger user construction operation
final IoFuture futureChannel = connection.openChannel(serviceName, optionMap);
futureChannel.addNotifier(new IoFuture.HandlingNotifier>() {
public void handleCancelled(final FutureResult futureResult) {
futureResult.setCancelled();
attachments.removeAttachment(key, futureResult.getIoFuture());
}
public void handleFailed(final IOException exception, final FutureResult futureResult) {
futureResult.setException(exception);
attachments.removeAttachment(key, futureResult.getIoFuture());
}
public void handleDone(final Channel channel, final FutureResult futureResult) {
ClientServiceHandle.this.channel = channel;
final IoFuture nextFuture = constructor.apply(channel);
nextFuture.addNotifier(new IoFuture.HandlingNotifier>() {
public void handleCancelled(final FutureResult futureResult) {
safeClose(channel);
futureResult.setCancelled();
log.tracef("ClientServiceHandle %s ('%s') cancelling service at connection %s", this, serviceName, connection);
attachments.removeAttachment(key, futureResult.getIoFuture());
}
public void handleFailed(final IOException exception, final FutureResult futureResult) {
safeClose(channel);
futureResult.setException(exception);
log.tracef("ClientServiceHandle %s ('%s') failed service at connection %s", this, serviceName, connection);
attachments.removeAttachment(key, futureResult.getIoFuture());
}
public void handleDone(final T result, final FutureResult futureResult) {
// Publish result
futureResult.setResult(result);
// Optimize overall
attachments.replaceAttachment(key, futureResult.getIoFuture(), new FinishedIoFuture(result));
// Remove on close
channel.addCloseHandler((closed, exception) -> {
log.tracef("ClientServiceHandle %s ('%s') closing service at connection %s", this, serviceName, connection);
attachments.removeAttachment(key);
});
}
}, futureResult);
// make sure cancel requests now pass up to the service future
futureResult.addCancelHandler(nextFuture);
}
}, futureResult);
// make sure cancel requests pass up to the channel open request
futureResult.addCancelHandler(futureChannel);
return future;
}
/**
* Close the channel associated with this handle
*/
public void closeChannel() throws IOException {
safeClose(channel);
}
}