com.sun.enterprise.transaction.config.TransactionService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project for IBM JDK
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 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 com.sun.enterprise.transaction.config;
import org.glassfish.api.admin.config.ConfigExtension;
import org.glassfish.api.admin.config.Container;
import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.config.Element;
import org.jvnet.hk2.config.types.Property;
import org.jvnet.hk2.config.types.PropertyBag;
import java.util.List;
import java.beans.PropertyVetoException;
import org.glassfish.config.support.datatypes.PositiveInteger;
import org.glassfish.api.admin.config.PropertyDesc;
import org.glassfish.api.admin.config.PropertiesDesc;
import javax.validation.constraints.Min;
/**
* Configuration for Transaction Manager
*/
/* @XmlType(name = "", propOrder = {
"property"
}) */
@Configured
public interface TransactionService extends ConfigBeanProxy, PropertyBag, ConfigExtension, Container {
/**
* Gets the value of the automaticRecovery property.
*
* If true, server instance attempts recovery at restart
*
* @return possible object is
* {@link String }
*/
@Attribute (defaultValue="false",dataType=Boolean.class)
public String getAutomaticRecovery();
/**
* Sets the value of the automaticRecovery property.
*
* @param value allowed object is
* {@link String }
*/
public void setAutomaticRecovery(String value) throws PropertyVetoException;
/**
* Gets the value of the timeoutInSeconds property.
*
* amount of time the transaction manager waits for response from a
* datasource participating in transaction.
* A value of 0 implies infinite timeout
*
* @return possible object is
* {@link String }
*/
@Attribute (defaultValue="0",dataType=Integer.class)
public String getTimeoutInSeconds();
/**
* Sets the value of the timeoutInSeconds property.
*
* @param value allowed object is
* {@link String }
*/
public void setTimeoutInSeconds(String value) throws PropertyVetoException;
/**
* Gets the value of the txLogDir property.
*
* Transaction service creates a sub directory 'tx' under tx-log-dir to
* store the transaction logs. The default value of the tx-log-dir is
* $INSTANCE-ROOT/logs. If this attribute is not explicitly specified in the
* element, 'tx' sub directory will be created under
* the path specified in log-root attribute of element.
*
* @return possible object is
* {@link String }
*/
@Attribute
public String getTxLogDir();
/**
* Sets the value of the txLogDir property.
*
* @param value allowed object is
* {@link String }
*/
public void setTxLogDir(String value) throws PropertyVetoException;
/**
* Gets the value of the heuristicDecision property.
*
* During recovery, if outcome of a transaction cannot be determined from
* the logs, then this property is used to fix the outcome
*
* @return possible object is
* {@link String }
*/
@Attribute (defaultValue="rollback")
public String getHeuristicDecision();
/**
* Sets the value of the heuristicDecision property.
*
* @param value allowed object is
* {@link String }
*/
public void setHeuristicDecision(String value) throws PropertyVetoException;
/**
* Gets the value of the retryTimeoutInSeconds property.
*
* Used to determine the retry time in the following scenarios.
*
* 1 Time to wait at the transaction recovery time, when resources are
* unreachable.
* 2 If there are any transient exceptions in the second phase of the
* two PC protocol.
*
* A negative value indicates infinite retry. '0' indicates no retry.
* A positive value indicates the number of seconds for which retry will be
* attempted. Default is 10 minutes which may be appropriate for a database
* being restarted
*
* @return possible object is
* {@link String }
*/
@Attribute (defaultValue="600",dataType=Integer.class)
public String getRetryTimeoutInSeconds();
/**
* Sets the value of the retryTimeoutInSeconds property.
*
* @param value allowed object is
* {@link String }
*/
public void setRetryTimeoutInSeconds(String value) throws PropertyVetoException;
/**
* Gets the value of the keypointInterval property.
*
* property used to specify the number of transactions between keypoint
* operations on the log. A Keypoint operations could reduce the size of the
* transaction log files. A larger value for this property
* (for example, 1000) will result in larger transaction log files,
* between log compactions, but less keypoint operations, and potentially
* better performance. A smaller value (e.g. 20) results in smaller log
* files but slightly reduced performance due to the greater frequency of
* keypoint operations.
*
* @return possible object is
* {@link String }
*/
@Attribute (defaultValue="65536")
public String getKeypointInterval();
/**
* Sets the value of the keypointInterval property.
*
* @param value allowed object is
* {@link String }
*/
public void setKeypointInterval(String value) throws PropertyVetoException;
/**
Properties.
*/
@PropertiesDesc(
props={
@PropertyDesc(name="oracle-xa-recovery-workaround", defaultValue="true", dataType=Boolean.class,
description="If true, the Oracle XA Resource workaround is used in transaction recovery"),
@PropertyDesc(name="disable-distributed-transaction-logging", defaultValue="false", dataType=Boolean.class,
description="If true, disables transaction logging, which might improve performance. " +
"If the automatic-recovery attribute is set to true , this property is ignored"),
@PropertyDesc(name="xaresource-txn-timeout", defaultValue="120", dataType=PositiveInteger.class,
description=" Changes the XAResource timeout. In some cases, the XAResource default timeout can cause " +
"transactions to be aborted, so it is desirable to change it"),
@PropertyDesc(name="pending-txn-cleanup-interval", defaultValue="60", dataType=PositiveInteger.class,
description="Interval in seconds at which an asynchronous thread checks for pending transactions and completes them"),
@PropertyDesc(name="use-last-agent-optimization", defaultValue="true", dataType=Boolean.class,
description="Enables last agent optimization, which improves the throughput of transactions. " +
"If one non-XA resource is used with XA resources in the same transaction, the non XA resource is the last agent"),
@PropertyDesc(name="wait-time-before-recovery-insec", defaultValue="60", dataType=PositiveInteger.class,
description="Wait time in seconds after which an instance starts the recovery for a dead instance"),
@PropertyDesc(name="db-logging-resource",
description="db-logging-resource NDI name of the JDBC resource for the database to which transactions are logged")
}
)
@Element
List getProperty();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy