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 Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging 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: 35.0.0.Beta1

Show newest version

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2011, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.ejb.client;

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

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 IDs.  This key is normally associated with an invocation.
     */
    public static final AttachmentKey TRANSACTION_ID_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();


    /**
     * An attachment key which specifies whether "hints" (like {@link org.jboss.ejb.client.annotation.CompressionHint}) are disabled
     */
    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
     */
    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
     */
    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 EJB invocation should be compressed
     */
    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 EJB invocation
     */
    public static final AttachmentKey RESPONSE_COMPRESSION_LEVEL = new AttachmentKey();
}