org.jboss.ejb.client.AbstractInvocationContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-ejb-client Show documentation
Show all versions of jboss-ejb-client Show documentation
Client library for EJB applications working against Wildfly - Jakarta EE Variant
/*
* 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.ejb.client;
import static org.jboss.ejb._private.Keys.AUTHENTICATION_CONTEXT_ATTACHMENT_KEY;
import java.io.Serializable;
import java.net.URI;
import java.util.LinkedHashMap;
import java.util.Map;
import org.wildfly.common.Assert;
import org.wildfly.security.auth.client.AuthenticationContext;
import org.wildfly.transaction.client.AbstractTransaction;
/**
* The base class of invocation contexts consumed by interceptors and receivers.
*
* @author David M. Lloyd
*/
public abstract class AbstractInvocationContext extends Attachable {
private final AuthenticationContext authenticationContext;
private final EJBClientContext ejbClientContext;
// selected target receiver
private EJBReceiver receiver;
private EJBLocator locator;
private Affinity weakAffinity = Affinity.NONE;
private URI destination;
private Affinity targetAffinity;
private String initialCluster;
/**
* Gets the initial cluster assignment by discovery, if any
*
* @return the initial cluster if assigned
*/
public String getInitialCluster() {
return initialCluster;
}
void setInitialCluster(String initialCluster) {
this.initialCluster = initialCluster;
}
private Map contextData;
private AbstractTransaction transaction;
AbstractInvocationContext(final EJBLocator locator, final EJBClientContext ejbClientContext,
final AuthenticationContext authenticationContext) {
this.locator = locator;
this.ejbClientContext = ejbClientContext;
this.authenticationContext = authenticationContext;
}
public AuthenticationContext getAuthenticationContext() {
AuthenticationContext attached = getAttachment(AUTHENTICATION_CONTEXT_ATTACHMENT_KEY);
return attached != null ? attached : authenticationContext;
}
/**
* Get the Enterprise Beans client context associated with this invocation.
*
* @return the Enterprise Beans client context
*/
public EJBClientContext getClientContext() {
return ejbClientContext;
}
/**
* Get the context data. This same data will be made available verbatim to
* server-side interceptors via the {@code InvocationContext.getContextData()} method, and thus
* can be used to pass data from the client to the server (as long as all map values are
* {@link Serializable}).
*
* @return the context data
*/
public Map getContextData() {
final Map contextData = this.contextData;
if (contextData == null) {
return this.contextData = new LinkedHashMap();
} else {
return contextData;
}
}
/**
* Get the locator for the invocation target.
*
* @return the locator
*/
public EJBLocator getLocator() {
return locator;
}
/**
* Set the locator for the invocation target.
*
* @param locator the locator for the invocation target
*/
public void setLocator(final EJBLocator locator) {
this.locator = locator;
}
/**
* Get the resolved destination of this invocation. If the destination is not yet decided, {@code null} is
* returned.
*
* @return the resolved destination of this invocation, or {@code null} if it is not yet known
*/
public URI getDestination() {
return destination;
}
/**
* Set the resolved destination of this invocation. The destination must be decided by the end of the interceptor
* chain, otherwise an exception will result.
*
* @param destination the resolved destination of this invocation
*/
public void setDestination(final URI destination) {
this.destination = destination;
}
/**
* Get the resolved target affinity of this invocation. If the target affinity is not yet decided, {@code null}
* is returned. The target affinity is retained only for the lifetime of the invocation; it may be used to aid
* in resolving the {@linkplain #setDestination(URI) destination to set}.
*
* @return the resolved target affinity of this invocation, or {@code null} if it is not yet known
*/
public Affinity getTargetAffinity() {
return targetAffinity;
}
/**
* Set the resolved target affinity of this invocation.
*
* @param targetAffinity the resolved target affinity of this invocation
*/
public void setTargetAffinity(final Affinity targetAffinity) {
this.targetAffinity = targetAffinity;
}
/**
* Get the Enterprise Beans receiver associated with this invocation.
*
* @return the Enterprise Beans receiver
*/
EJBReceiver getReceiver() {
return receiver;
}
/**
* Set the Enterprise Beans receiver associated with this invocation.
*
* @param receiver the Enterprise Beans receiver associated with this invocation
*/
void setReceiver(final EJBReceiver receiver) {
this.receiver = receiver;
}
/**
* Get the invocation weak affinity.
*
* @return the invocation weak affinity, or {@link Affinity#NONE} if none (not {@code null})
*/
public Affinity getWeakAffinity() {
return weakAffinity;
}
/**
* Set the invocation weak affinity.
*
* @param weakAffinity the invocation weak affinity (must not be {@code null})
*/
public void setWeakAffinity(final Affinity weakAffinity) {
Assert.checkNotNullParam("weakAffinity", weakAffinity);
this.weakAffinity = weakAffinity;
}
/**
* Get the invoked view class.
*
* @return the invoked view class
*/
public Class getViewClass() {
return locator.getViewType();
}
/**
* Request that the current operation be retried if possible.
*/
public abstract void requestRetry();
/**
* Get the transaction associated with the invocation. If there is no transaction (i.e. transactions should not
* be propagated), {@code null} is returned.
*
* @return the transaction associated with the invocation, or {@code null} if no transaction should be propagated
*/
public AbstractTransaction getTransaction() {
return transaction;
}
/**
* Set the transaction associated with the invocation. If there is no transaction (i.e. transactions should not
* be propagated), {@code null} should be set.
*
* @param transaction the transaction associated with the invocation, or {@code null} if no transaction should be
* propagated
*/
public void setTransaction(final AbstractTransaction transaction) {
this.transaction = transaction;
}
}