org.jboss.ejb.client.AttachmentKeys Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

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).

There is a newer version: 34.0.0.Final

Show 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.ejb.client;

import java.lang.reflect.Method;
import java.util.Map;

import jakarta.transaction.Transaction;

import org.jboss.ejb.client.annotation.CompressionHint;

/**
 * Commonly-used attachment keys.
 *
 * @author David M. Lloyd
 */
public final class AttachmentKeys {
    private AttachmentKeys() {
    }

    /**
     * The attachment key for transaction propagation.
     */
    public static final AttachmentKey TRANSACTION_KEY = new AttachmentKey<>();

    /**
     * The preferred node or cluster for invocations from this proxy.  Note that this name is only a
     * recommendation and is not required to be used, and if the node or cluster is not available then the invocation
     * may proceed to another node or cluster.  This key is normally associated with a proxy, and copied to an invocation.
     */
    public static final AttachmentKey WEAK_AFFINITY = new AttachmentKey();

    /**
     * The attachment key for legacy transaction IDs.  This key is normally associated with an invocation.
     */
    @Deprecated
    public static final AttachmentKey TRANSACTION_ID_KEY = new AttachmentKey();

    /**
     * An attachment key which specifies whether "hints" (like {@link org.jboss.ejb.client.annotation.CompressionHint}) are disabled
     */
    @Deprecated
    public static final AttachmentKey HINTS_DISABLED = new AttachmentKey();

    /**
     * A key to an attachment which contains the {@link org.jboss.ejb.client.annotation.CompressionHint}s specified on the remote view class level
     */
    @Deprecated
    public static final AttachmentKey VIEW_CLASS_DATA_COMPRESSION_HINT_ATTACHMENT_KEY = new AttachmentKey();

    /**
     * A key to an attachment which contains the {@link org.jboss.ejb.client.annotation.CompressionHint}s for methods which have been annotated with that data
     */
    @Deprecated
    public static final AttachmentKey> VIEW_METHOD_DATA_COMPRESSION_HINT_ATTACHMENT_KEY = new AttachmentKey>();

    /**
     * A key to an attachment which specifies whether the response payload data of an Enterprise Bean invocation should be compressed
     */
    @Deprecated
    public static final AttachmentKey COMPRESS_RESPONSE = new AttachmentKey();

    /**
     * A key to an attachment which specifies the "compression level" of the response payload data of an Enterprise Bean invocation
     */
    @Deprecated
    public static final AttachmentKey RESPONSE_COMPRESSION_LEVEL = new AttachmentKey();
}