java/javax/annotation/sql/DataSourceDefinition.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 javax.annotation.sql;

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

/**
 * @since Common Annotations 1.1
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DataSourceDefinition {

    /**
     * @return the className
     */
    String className();

    /**
     * @return the name
     */
    String name();

    /**
     * @return the description
     */
    String description() default "";

    /**
     * @return the url
     */
    String url() default "";

    /**
     * @return the user
     */
    String user() default "";

    /**
     * @return the password
     */
    String password() default "";

    /**
     * @return database name
     */
    String databaseName() default "";

    /**
     * @return the port number
     */
    int portNumber() default -1;

    /**
     * @return the server name
     */
    String serverName() default "localhost";

    /**
     * @return the isolation level
     */
    int isolationLevel() default -1;

    /**
     * @return true if the data source is transactional
     */
    boolean transactional() default true;

    /**
     * @return the initial pool size
     */
    int initialPoolSize() default -1;

    /**
     * @return the max pool size
     */
    int maxPoolSize() default -1;

    /**
     * @return the min pool size
     */
    int minPoolSize() default -1;

    /**
     * @return the max idle time
     */
    int maxIdleTime() default -1;

    /**
     * @return the max statements
     */
    int maxStatements() default -1;

    /**
     * @return a String[] with the properties
     */
    String[] properties() default {};

    /**
     * @return the login timeout
     */
    int loginTimeout() default 0;
}