com.oracle.bedrock.runtime.concurrent.AbstractControllableRemoteChannel Maven / Gradle / Ivy
Show all versions of bedrock-runtime Show documentation
/*
* File: AbstractControllableRemoteChannel.java
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* The contents of this file are subject to the terms and conditions of
* the Common Development and Distribution License 1.0 (the "License").
*
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the License by consulting the LICENSE.txt file
* distributed with this file, or by consulting https://oss.oracle.com/licenses/CDDL
*
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file LICENSE.txt.
*
* MODIFICATIONS:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*/
package com.oracle.bedrock.runtime.concurrent;
import com.oracle.bedrock.Option;
import com.oracle.bedrock.OptionsByType;
import com.oracle.bedrock.annotations.Internal;
import com.oracle.bedrock.runtime.concurrent.options.StreamName;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArraySet;
/**
* An abstract implementation of a {@link ControllableRemoteChannel}.
*
* Copyright (c) 2013. All Rights Reserved. Oracle Corporation.
* Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
*
* @author Brian Oliver
*/
@Internal
public abstract class AbstractControllableRemoteChannel implements ControllableRemoteChannel
{
/**
* A flag indicating the open state of the {@link ControllableRemoteChannel}.
*/
private volatile boolean isOpen;
/**
* The {@link RemoteChannelListener}s for the {@link ControllableRemoteChannel}.
*/
protected CopyOnWriteArraySet channelListeners;
/**
* The {@link RemoteEventListener}s for the {@link RemoteChannel} according to their {@link StreamName}.
*/
protected ConcurrentHashMap> eventListenersByStreamName;
/**
* Constructs an {@link AbstractControllableRemoteChannel}.
*/
public AbstractControllableRemoteChannel()
{
isOpen = false;
channelListeners = new CopyOnWriteArraySet<>();
eventListenersByStreamName = new ConcurrentHashMap<>();
}
/**
* Sets if the {@link ControllableRemoteChannel} is open.
*
* @param isOpen a flag indicating if the {@link ControllableRemoteChannel}
* is open
*/
protected synchronized void setOpen(boolean isOpen)
{
this.isOpen = isOpen;
}
@Override
public final synchronized void close()
{
if (isOpen)
{
isOpen = false;
onClose();
for (RemoteChannelListener listener : channelListeners)
{
try
{
listener.onClosed(this);
}
catch (Throwable throwable)
{
// we ignore exceptions that occur while notifying the listeners
}
}
}
}
/**
* Determines if the {@link ControllableRemoteChannel} is open.
*
* @return true if the {@link RemoteChannel} is open
*/
public synchronized boolean isOpen()
{
return isOpen;
}
/**
* Injects this {@link RemoteChannel} into the specified object annotated with
* {@link Inject}.
*
* @param object the non-null object in which to inject this {@link RemoteChannel}
*/
public void injectInto(Object object)
{
if (object != null)
{
try
{
// acquire the class of object so we can locate injection points
Class objectClass = object.getClass();
// acquire the classloader for the object in which to inject
ClassLoader loader = objectClass.getClassLoader();
// acquire the annotation class based on the class in which we have to inject
// (just in case it was loaded with a special class loader)
Class annotationClass =
(Class) loader.loadClass(RemoteChannel.Inject.class.getName());
// acquire the channel class
Class channelClass = this.getClass();
for (Method method : objectClass.getDeclaredMethods())
{
int modifiers = method.getModifiers();
if (method.getAnnotation(annotationClass) != null
&& method.getParameterTypes().length == 1
&& method.getParameterTypes()[0].isAssignableFrom(channelClass)
&& Modifier.isPublic(modifiers))
{
try
{
method.invoke(object, this);
}
catch (Exception e)
{
// carry on... perhaps we can use another approach?
}
}
}
for (Field field : objectClass.getDeclaredFields())
{
int modifiers = field.getModifiers();
if (field.getAnnotation(annotationClass) != null
&&!Modifier.isStatic(modifiers)
&& field.getType().isAssignableFrom(channelClass))
{
try
{
// ensure the field is accessible
try
{
field.setAccessible(true);
}
catch (Exception accessException)
{
// carry on... perhaps it will work?
}
// now set the value
field.set(object, this);
}
catch (Exception e)
{
// carry on... perhaps we can use another approach?
}
}
}
}
catch (ClassNotFoundException e)
{
e.printStackTrace();
}
}
}
@Override
public synchronized void addListener(RemoteChannelListener listener)
{
channelListeners.add(listener);
}
public synchronized void removeListener(RemoteChannelListener listener)
{
channelListeners.remove(listener);
}
@Override
public void addListener(RemoteEventListener listener,
Option... options)
{
OptionsByType optionsByType = OptionsByType.of(options);
StreamName streamName = optionsByType.get(StreamName.class);
eventListenersByStreamName.compute(streamName,
(name, eventListeners) -> {
if (eventListeners == null)
{
eventListeners = new CopyOnWriteArraySet<>();
}
eventListeners.add(listener);
return eventListeners;
});
}
@Override
public void removeListener(RemoteEventListener listener,
Option... options)
{
OptionsByType optionsByType = OptionsByType.of(options);
StreamName streamName = optionsByType.get(StreamName.class);
eventListenersByStreamName.computeIfPresent(streamName,
(name, eventListeners) -> {
eventListeners.remove(listener);
return eventListeners.size() == 0 ? null : eventListeners;
});
}
/**
* Handle when the {@link ControllableRemoteChannel} is closed.
*/
protected abstract void onClose();
}