org.jboss.jca.as.converters.ConnectionFactory Maven / Gradle / Ivy
The newest version!
/*
* IronJacamar, a Java EE Connector Architecture implementation
* 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.jca.as.converters;
import java.util.HashMap;
import java.util.Map;
/**
* Common ConnectionFactory
*
* @author Jeff Zhang
* @version $Revision: $
*/
public interface ConnectionFactory
{
/**
* Get the jndiName.
*
* @return the jndiName.
*/
public String getJndiName();
/**
*
* get the security domain for pure security-domain security management
*
* @return the security-domain to use
*/
public String getSecurityDomain();
/**
* Get the minPoolSize.
*
* @return the minPoolSize.
*/
public Integer getMinPoolSize();
/**
* Get the maxPoolSize.
*
* @return the maxPoolSize.
*/
public Integer getMaxPoolSize();
/**
* Get the blockingTimeoutMillis.
*
* @return the blockingTimeoutMillis.
*/
public Long getBlockingTimeoutMillis();
/**
* Get the backgroundValidation.
*
* @return the backgroundValidation.
*/
public Boolean isBackgroundValidation();
/**
* Get the backgroundValidationMillis.
*
* @return the backgroundValidationMillis.
*/
public Long getBackgroundValidationMillis();
/**
* Get the idleTimeoutMinutes.
*
* @return the idleTimeoutMinutes.
*/
public Long getIdleTimeoutMinutes();
/**
* Get the allocationRetryWaitMillis.
*
* @return the allocationRetryWaitMillis.
*/
public Integer getAllocationRetry();
/**
* Get the allocationRetryWaitMillis.
*
* @return the allocationRetryWaitMillis.
*/
public Long getAllocationRetryWaitMillis();
/**
* Get the prefill.
*
* @return the prefill.
*/
public Boolean isPrefill();
/**
* Get the useFastFail.
*
* @return the useFastFail.
*/
public Boolean isUseFastFail();
/**
*
* A Tag.
*/
public enum Tag
{
/**
* always first
*/
UNKNOWN(null),
/**
* jndiName tag
*/
JNDI_NAME("jndi-name"),
/**
* security-domain tag
*/
SECURITY_DOMAIN("security-domain"),
/**
* security-domain-and-application tag
*/
SECURITY_DOMAIN_AND_APPLICATION("security-domain-and-application"),
/**
* min-pool-size tag
*/
MIN_POOL_SIZE("min-pool-size"),
/**
* maxPoolSize tag
*/
MAX_POOL_SIZE("max-pool-size"),
/**
* blockingTimeoutMillis tag
*/
BLOCKING_TIMEOUT_MILLIS("blocking-timeout-millis"),
/**
* backgroundValidation tag
*/
BACKGROUND_VALIDATION("background-validation"),
/**
* backgroundValidationMillis tag
*/
BACKGROUND_VALIDATION_MILLIS("background-validation-millis"),
/**
* idleTimeoutMinutes tag
*/
IDLE_TIMEOUT_MINUTES("idle-timeout-minutes"),
/**
* allocationRetry tag
*/
ALLOCATION_RETRY("allocation-retry"),
/**
* allocationRetryWaitMillis tag
*/
ALLOCATION_RETRY_WAIT_MILLIS("allocation-retry-wait-millis"),
/**
* prefill tag
*/
PREFILL("prefill"),
/**
* useFastFail tag
*/
USE_FAST_FAIL("use-fast-fail");
private final String name;
/**
*
* Create a new Tag.
*
* @param name a name
*/
Tag(final String name)
{
this.name = name;
}
/**
* Get the local name of this element.
*
* @return the local name
*/
public String getLocalName()
{
return name;
}
/**
* {@inheritDoc}
*/
public String toString()
{
return name;
}
private static final Map MAP;
static
{
final Map map = new HashMap();
for (Tag element : values())
{
final String name = element.getLocalName();
if (name != null)
map.put(name, element);
}
MAP = map;
}
/**
*
* Static method to get enum instance given localName XsdString
*
* @param localName a XsdString used as localname (typically tag name as defined in xsd)
* @return the enum instance
*/
public static Tag forName(String localName)
{
final Tag element = MAP.get(localName);
return element == null ? UNKNOWN : element;
}
}
}