Glassfish example source code file (Create.java)

This example Glassfish source code file (Create.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Glassfish tags/keywords

annotation, class, class, contract, create, create, creationdecorator, creationdecorator, crudresolver, executeon, executeon, i18n, index, inhabitantannotation, string

The Glassfish Create.java source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  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 at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * 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]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.config.support;

import org.glassfish.api.I18n;
import org.glassfish.api.admin.ExecuteOn;
import org.jvnet.hk2.annotations.*;
import org.glassfish.api.admin.AdminCommand;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Create command annotation.
 *
 * Methods annotated with this annotation delegates to the framework
 * to provide a generic administrative command that create configured
 * instances.
 *
 * A Create annotation is used on a method of a configured interface.
 * The method identifies the setter of a type that can be added to the
 * configured interface.
 *
 * The annotated method must follow one of the two pattern :
 *    List<X> getXs();
 * or
 *    void setX(X x);
 *
 * the name of the method is immaterial, only the generic type of the
 * returned List or the single parameter of the setter method are used
 * to determine the type of configured instance the command will create.
 *
 * the resolver is used to find which instance of the parent type should
 * be used to add the newly created child. The resolver can also
 * be annotated with {@link org.glassfish.api.Param} to get parameters
 * passed to the command invocation (like a name or a target parameter).
 *
 * The generic command implementation will use the parameters passed to
 * the command invocation with the {@link org.glassfish.api.Param}
 * annotations on the child type to match command parameters to
 * configuration attributes.
 *
 * Sometimes, the creation of a new configuration will require more
 * work or more attributes/elements creation than what can be provided
 * or specified during the command invocation. In such a case, the
 * Create annotation can specify a decorator that will be called during
 * the generic command execution, with the newly created instance.
 *
 * The {@link CreationDecorator} will be looked up by its type and
 * normal injection or parameter injection can happen.
 *
 * Internationalization of generic commands follow the same rule as
 * described in the {@link AdminCommand} javadocs. The {@link I18n}
 * annotation referenced from this annotation will be used as the
 * top level command annotation, which should provide the command
 * description and expected result.
 *
 * Parameters can be annotated with @I18n as well to override the
 * default mapping and all resources must be located in the target
 * type module local strings properties file.
 *
 * @author Jerome Dochez
 */
@Contract
@Retention(RUNTIME)
@Target(ElementType.METHOD)
@InhabitantAnnotation("default")
@ContractProvided(AdminCommand.class)
@ServiceProvider(GenericCreateCommand.class)
public @interface Create {

    /**
     * Name of the command that will be used to register this generic command implementation under.
     *
     * @return the command name as the user types it.
     */
    @Index
    String value();

    /**
     * Returns the instance of the parent that should be used to add the newly created
     * instance under. The implementation of that interface can use the command parameters
     * to make a determination about which instance should be used.
     *
     * @return the parent instance. 
     */
    Class<? extends CrudResolver> resolver() default CrudResolver.DefaultResolver.class;

    /**
     * Returns a decorator type that should be looked up and called when a new
     * configuration element of the annotated type is created.
     *
     * @return a decorator for the annotated type
     */
    Class<? extends CreationDecorator> decorator() default CreationDecorator.NoDecoration.class;

    /**
     * Returns the desired behaviors in a clustered environment. By default, using all the
     * {@link ExecuteOn} default values
     *
     * @return the cluster information
     */
    ExecuteOn cluster() default @ExecuteOn();

    /**
     * Returns the i18n key that will be used to look up a localized string in the annotated
     * type module.
     *
     * @return the key to look up localized description for the command.
     */
    I18n i18n();

}