appserver/admingui/gf-admingui-connector/src/main/java/org/glassfish/admingui/connector/IntegrationPoint.java

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * 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 org.glassfish.admingui.connector;

import org.glassfish.api.admingui.ConsoleProvider;

import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.Configured;

import java.io.Serializable;


/**
 *  <p>        An <code>IntegrationPoint</code> represents the data necessary to
 * describe a particular integration point into the admin console.  Some
 * examples of integration points include:</p>
 *
 *  <ul><li>Add a TreeNode to the navigation tree</li>
 * <li>Add a HelpContent to the application</li>
 * <li>Add initialization logic to execute when a user logins into the
 *     application</li>
 * <li>Add content to a specific page within the application</li></ul>
 *
 *  <p>        The design of this data structure is intentionally very general so
 * that this data structure can be applied to a wide range of situations.
 * It also intentionally does not refer to gui concepts such as "tree" or
 * other UI elements so that these concepts be independent of this data as
 * much as possible.  This will allow some flexibility by the consumer of
 * this data to render it in an appropriate way (to some extent).  This
 * will however, be limited by the content of the data this structure
 * refers to (if any).</p>
 *
 *  <p>        The <code>IntegrationPoint</code> contains the following properties:</p>
 *
 *  <ul><li><code>type</code> - (required) A String specifying the integration
 *     type.</li>
 * <li><code>parentId</code> - The parent
 *     <code>IntegrationPoint</code>'s id.</li>
 * <li><code>priority</code> - A priority of this component, often used to
 *     compare or sort <code>IntegrationPoint</code>s.</li>
 * <li><code>providerId</code> - The {@link ConsoleProvider}'s id which provided
 *     this <code>IntegrationPoint</code>.</li>
 * <li><code>content</code> - A value pointing to additional content
 *     to implement this <code>IntegrationPoint</code></li>
 * <li><code>handlerId</code> - An <code>Handler</code> name which should
 *     be invoked to help implement this <code>IntegrationPoint</code></li>
 * <li><code>id</code> - A value used to identify this specific
 *     integration point.</li></ul>
 *
 *  <p>        All values in this class are immutable.</p>
 *
 *  @author Ken Paulsen        (ken.paulsen@sun.com)
 */
@Configured
public class IntegrationPoint implements Serializable {
    /**
     * <p> Default constructor.</p>
     */
    public IntegrationPoint() {
    }

// FIXME: Implement event / handler declarations

    /**
     * <p> The identifier of this <code>IntegrationPoint</code>.</p>
     */
    public String getId() {
        return id;
    }

    /**
     * <p> Setter for the identifier of the <code>IntegrationPoint</code>.</p>
     */
    @Attribute(required=true)
    void setId(String id) {
        this.id = id;
    }

    /**
     * <p> This specifies the type of this <code>IntegrationPoint</code>.  The
     *     type might specify that this integration is a "navigation"
     *     integration, "help" integration, "applicationPage" integration, or
     *     any other supported integration type.</p>
     */
    public String getType() {
        return type;
    }

    /**
     * <p> Setter for the type of the <code>IntegrationPoint</code>.</p>
     */
    @Attribute(required=true)
    void setType(String type) {
        this.type = type;
    }

    /**
     * <p> The parent identifier.  Useful when an
     *     <code>IntegrationPoint</code> needs to refer to another integration
     *     point (such as when specifying which TreeNode to fall under.</p>
     */
    public String getParentId() {
        return parentId;
    }

    /**
     * <p> Setter for the parentId of the <code>IntegrationPoint</code>.</p>
     */
    @Attribute("parentId")
    void setParentId(String parentId) {
        this.parentId = parentId;
    }

    /**
     * <p> A reference to extra information needed to use this
     *     <code>IntegrationPoint</code>.  An example might be a .jsf page
     *     reference which should be included.  Or a location used to find
     *     HelpSet information.</p>
     */
    public String getContent() {
        return content;
    }

    /**
     * <p> Setter for the content of the <code>IntegrationPoint</code>.</p>
     */
    @Attribute
    void setContent(String content) {
        this.content = content;
    }

    /**
     * <p> This specifies the relative priority of this
     *     <code>IntegrationPoint</code>.  This may be used for sorting
     *     multiple <code>IntegrationPoints</code>, or for other
     *     implementation-specific purposes.</p>
     */
    public int getPriority() {
        return priority;
    }

    /**
     * <p> Setter for the priority of the <code>IntegrationPoint</code>.</p>
     */
    @Attribute
    void setPriority(int priority) {
        this.priority = priority;
    }

    /**
     * <p> Overrides the toString() method.</p>
     */
    public String toString() {
        return "[IntegrationPoint: '" + id + "' = '" + content + "']";
    }

    /**
     * <p> This provides access to the {@link ConsoleConfig} which provided
     *     this <code>IntegrationPoint</code>.
     */
    public String getConsoleConfigId() {
        return this.configId;
    }

    /**
     * <p> This method should only be called by the
     *     {@link ConsolePluginService}.  This associates this
     *     <code>IntegrationPoint</code> with the {@link ConsoleConfig}
     *     which specified it.</p>
     */
    public void setConsoleConfigId(String id) {
        this.configId = id;
    }


    private String id;
    private String type;
    private String parentId;
    private String content;
    private int priority;
    private String configId = null;
}