MongoClientDefinition.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2014, Red Hat, Inc., and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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.javaee.mongodb;

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

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

/**
 *
 * Annotation Used to define a MongoDB data source
 * 
 * @author Antoine Sabot-Durand
 * 
 */


@Target(value = {TYPE})
@Retention(value = RUNTIME)
@Documented
public @interface MongoClientDefinition {
    /**
     * @return name by which the data source will be registered.
     */
    String name();

    /**
     * @return description of this data source
     */
    String description() default "";

    /**
     * @return mongo db URL.
     */
    String url() default "";
}