001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.tm;
023:
024: /**
025: * MBean interface.
026: */
027: public interface XidFactoryMBean {
028:
029: /**
030: * mbean get-set pair for field BaseGlobalId Get the value of BaseGlobalId
031: * @return value of BaseGlobalId
032: */
033: java.lang.String getBaseGlobalId();
034:
035: /**
036: * Set the value of BaseGlobalId
037: * @param BaseGlobalId Value to assign to BaseGlobalId
038: */
039: void setBaseGlobalId(java.lang.String baseGlobalId);
040:
041: /**
042: * mbean get-set pair for field globalIdNumber Get the value of globalIdNumber
043: * @return value of globalIdNumber
044: */
045: long getGlobalIdNumber();
046:
047: /**
048: * Set the value of globalIdNumber
049: * @param globalIdNumber Value to assign to globalIdNumber
050: */
051: void setGlobalIdNumber(long globalIdNumber);
052:
053: /**
054: * mbean get-set pair for field pad Get the value of pad
055: * @return value of pad
056: */
057: boolean isPad();
058:
059: /**
060: * Set the value of pad
061: * @param pad Value to assign to pad
062: */
063: void setPad(boolean pad);
064:
065: /**
066: * mbean get-set pair for field instance Get the value of instance
067: * @return value of instance
068: */
069: org.jboss.tm.XidFactoryMBean getInstance();
070:
071: /**
072: * Describe <code>newXid</code> method here.
073: * @return a <code>XidImpl</code> value
074: */
075: org.jboss.tm.XidImpl newXid();
076:
077: /**
078: * Describe <code>newBranch</code> method here.
079: * @param xid a <code>XidImpl</code> value
080: * @param branchIdNum a <code>long</code> value
081: * @return a <code>XidImpl</code> value
082: */
083: org.jboss.tm.XidImpl newBranch(org.jboss.tm.XidImpl xid,
084: long branchIdNum);
085:
086: /**
087: * Extracts the local id contained in a global id.
088: * @param globalId a global id
089: * @return the local id extracted from the global id
090: */
091: long extractLocalIdFrom(byte[] globalId);
092:
093: /**
094: * Describe <code>toString</code> method here.
095: * @param xid a <code>Xid</code> value
096: * @return a <code>String</code> value
097: */
098: java.lang.String toString(javax.transaction.xa.Xid xid);
099:
100: }
|