001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.transaction.participant;
020
021import org.jpos.core.Configurable;
022import org.jpos.core.Configuration;
023import org.jpos.transaction.Context;
024import org.jpos.transaction.GroupSelector;
025
026import java.io.Serializable;
027
028/**
029 * HasEntry is a general purpose GroupSelector that can be used to
030 * verify that a given object is available in the context.
031 * It checks the Context for the given entry ('name' property) and returns
032 * the content of the 'yes' or 'no' properties as the group list.
033 * If "yes" or "no" is not specified, it returns the constant UNKNOWN
034 */
035public class HasEntry implements GroupSelector, Configurable {
036    /** Default constructor; no instance state to initialise. */
037    public HasEntry() {}
038    private Configuration cfg;
039    /** Configuration property whose value is returned when the context entry is present. */
040    public static final String YES = "yes";
041    /** Configuration property whose value is returned when the context entry is absent. */
042    public static final String NO  = "no";
043    /** Default selector returned when neither {@link #YES} nor {@link #NO} is configured. */
044    public static final String UNKNOWN = "UNKNOWN";
045    public int prepare (long id, Serializable o) {
046        return PREPARED | NO_JOIN | READONLY;
047    }
048    public String select (long id, Serializable ser) {
049        Context ctx = (Context) ser;
050        String name = cfg.get ("name");
051        String action = ctx.get (name) != null ? YES : NO;
052        return cfg.get (action, UNKNOWN);
053    }
054    public void commit (long id, Serializable o) { }
055    public void abort  (long id, Serializable o) { }
056    public void setConfiguration (Configuration cfg) {
057        this.cfg = cfg;
058    }
059}
060