ObjAdminEvent.java

/*
 * Copyright (c) 2000, 2017 Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2021, 2022 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package com.sun.messaging.jmq.admin.apps.console.event;

import java.util.Properties;
import java.util.Vector;
import com.sun.messaging.jmq.admin.event.AdminEvent;
import com.sun.messaging.jmq.admin.objstore.ObjStore;
import com.sun.messaging.jmq.admin.objstore.ObjStoreManager;
import com.sun.messaging.jmq.admin.objstore.ObjStoreAttrs;

/**
 * Event class indicating some action related to Administered Object Management is needed.
 * <P>
 * The fields of this event include the various pieces of information needed for object management tasks.
 */
public class ObjAdminEvent extends AdminEvent {
    private static final long serialVersionUID = 5437958055298936323L;
    /*
     * ObjAdminEvent event types
     */
    public static final int ADD_OBJSTORE = 1;
    public static final int UPDATE_OBJSTORE = 2;
    public static final int DELETE_OBJSTORE = 3;
    public static final int ADD_DESTINATION = 4;
    public static final int UPDATE_DESTINATION = 5;
    public static final int ADD_CONN_FACTORY = 6;
    public static final int UPDATE_CONN_FACTORY = 7;
    public static final int UPDATE_CREDENTIALS = 8;

    /*
     * Types of admin objects that can be created/updated.
     */
    public static final int QUEUE = 1;
    public static final int TOPIC = 2;
    public static final int QCF = 3;
    public static final int TCF = 4;
    public static final int XAQCF = 5;
    public static final int XATCF = 6;
    public static final int CF = 7;
    public static final int XACF = 8;

    private transient ObjStore os = null;
    private ObjStoreAttrs osa = null;
    private transient ObjStoreManager osMgr = null;
    private String lookupName = null;
    private int destType;
    private int factoryType;
    private String id = null;
    private boolean readOnly = false;
    private Properties objProps;
    private boolean okAction = true;
    private boolean connect = true;
    private Vector missingInfo;

    /**
     * Creates an instance of ObjAdminEvent
     *
     * @param source the object where the event originated
     * @param type the event type
     */
    public ObjAdminEvent(Object source, int type) {
        super(source, type);
    }

    /*
     * Set object store attributes. This may be needed for object store creation for example.
     *
     * @param osa Object Store Attributes to set on this event object.
     */
    public void setObjStoreAttrs(ObjStoreAttrs osa) {
        this.osa = osa;
    }

    /*
     * Return object store attributes.
     *
     * @return Object Store Attributes.
     */
    public ObjStoreAttrs getObjStoreAttrs() {
        return (this.osa);
    }

    /*
     * Set object store.
     *
     * @param os Object Store to set on this event object.
     */
    public void setObjStore(ObjStore os) {
        this.os = os;
    }

    /*
     * Returns the object store.
     *
     * @return The Object Store.
     */
    public ObjStore getObjStore() {
        return (this.os);
    }

    /*
     * Set new object store id (for an update).
     *
     * @param id id Object Store to set on this event object.
     */
    public void setObjStoreID(String id) {
        this.id = id;
    }

    /*
     * Get new object store id (for an update).
     *
     * @return The Obj Store ID
     */
    public String getObjStoreID() {
        return this.id;
    }

    public void setReadOnly(boolean readOnly) {
        this.readOnly = readOnly;
    }

    public boolean isReadOnly() {
        return this.readOnly;
    }

    /*
     * Set dest destination type.
     *
     * @param type Type of destination
     */
    public void setDestinationType(int destType) {
        this.destType = destType;
    }

    /*
     * Returns the destination type
     *
     * @return The Destination Type
     */
    public int getDestinationType() {
        return (this.destType);
    }

    /*
     * Set connectio factory type.
     *
     * @param type Type of destination
     */
    public void setFactoryType(int factoryType) {
        this.factoryType = factoryType;
    }

    /*
     * Returns the factory type
     *
     * @return The Factory Type
     */
    public int getFactoryType() {
        return (this.factoryType);
    }

    /*
     * Set lookup name.
     *
     * @param lookupName The Lookup Name
     */
    public void setLookupName(String lookupName) {
        this.lookupName = lookupName;
    }

    /*
     * Returns the lookup name.
     *
     * @return The Lookup Name
     */
    public String getLookupName() {
        return (this.lookupName);
    }

    /*
     * Set object store manager.
     *
     * @param osMgr Object Store Manager to set on this event object.
     */
    public void setObjStoreManager(ObjStoreManager osMgr) {
        this.osMgr = osMgr;
    }

    /*
     * Returns the object store manager.
     *
     * @return The Object Store Manager.
     */
    public ObjStoreManager getObjStoreManager() {
        return (osMgr);
    }

    /*
     * Set object properties.
     *
     * @param objProps Properties to set on the Administered Object.
     */
    public void setObjProperties(Properties objProps) {
        this.objProps = objProps;
    }

    /*
     * Returns the object properties;
     *
     * @return The Object Properties;
     */
    public Properties getObjProperties() {
        return (objProps);
    }

    /*
     * Set missing authorization info
     *
     * @param missingInfo Vector of security properties that are missing.
     */
    public void setMissingAuthInfo(Vector missingInfo) {
        this.missingInfo = missingInfo;
    }

    /*
     * Returns the Vector
     *
     * @return The Vector of Properties;
     */
    public Vector getMissingAuthInfo() {
        return (missingInfo);
    }

    /*
     * Set whether this event is trigerred by an 'OK' action. This information is used to determine whether the originating
     * dialog (if one was involved) needs to be hidden.
     *
     * @param b True if this is an 'OK' action, false otherwise.
     */
    public void setOKAction(boolean b) {
        this.okAction = b;
    }

    /*
     * Returns whether this event is trigerred by an 'OK' action.
     *
     * @return True if this is an 'OK' action, false otherwise.
     */
    public boolean isOKAction() {
        return (okAction);
    }

    /*
     * Set whether to attempt to connect to the object store when adding/updating it.
     *
     * @param connect True if try to connect, false otherwise.
     */
    public void setConnectAttempt(boolean connect) {
        this.connect = connect;
    }

    /*
     * Returns whether or not to attempt to connect to the object store when adding/updating it.
     *
     * @return True if attempt to connect, false otherwise.
     */
    public boolean isConnectAttempt() {
        return (connect);
    }
}