StreamBaseAdminClient.hpp

// Copyright (c) 2004-2023 TIBCO Software Inc.  All rights reserved.

#ifndef STREAMBASE_NMCLIENT_H
#define STREAMBASE_NMCLIENT_H

#include "StreamBase.hpp"

#include "Exceptions.hpp"
#include "Schema.hpp"
#include "StreamProperties.hpp"
#include "StreamBaseURI.hpp"
#include "StreamBaseConstants.hpp"
#include "ClientSettings.hpp"

SB_INTERNAL_FWD(Admin)

SB_NAMESPACE_BEGIN;


/// The StreamBase Admin Client API.  Connects to a StreamBase node over the network,
/// via XML/RPC
class StreamBaseAdminClient
{
  public:
    /// Creates a StreamBase client and establishes a connection to a remote
    /// server.
    StreamBaseAdminClient(const StreamBaseURI& uri);

    /// Creates a StreamBase client and establishes a connection to a remote
    /// server.
    /// Note: The StreamBaseAdminClient only supports 1 URI in the list.
    StreamBaseAdminClient(const std::vector<StreamBaseURI>& uris = StreamBaseURI::vectorFromEnvironment());

    /// Creates a StreamBase client and establishes a connection to a remote
    /// server.
    /// Note: The StreamBaseAdminClient only supports 1 URI in the list.
    StreamBaseAdminClient(const std::vector<StreamBaseURI>& uris, sb::ClientSettings &settings);

    /// Destroys a session.
    virtual ~StreamBaseAdminClient();

    /// Shuts down the application/sbd.
    std::string shutdown();

    /// Shuts down a container or a Java Operator
    std::string shutdown(const std::string &name) ;

    /// Shuts down Java operators in an application.
    void shutdownOperators(std::vector<std::string> &operatorNames) ;

    /// Suspends Java operators in an application.
    void suspendOperators(std::vector<std::string> &operatorNames) ;

    /// Restarts one or more Operators in an application.
    void restartOperators(std::vector<std::string> &operatorNames) ;

    /// Suspends a container or a Java Operator
    void suspend(const std::string &name) ;

    /// Restarts a container 
    void restartContainer(const std::string &name) ;

    /// Resumes a container or a Java Operator
    void resume(const std::string &name) ;

    /// Resumes Java operators in an application.
    void resumeOperators(std::vector<std::string> &operatorNames) ;
    
    /// For the given Operator, return its set of properties and their values.
    void getOperatorProperties(const std::string &operatorName, std::vector<std::string> &result) ;

    /// Return the value of the given property on the given Operator.
    std::string getOperatorProperty(const std::string &operatorName, const std::string &propertyName) ;

    /// On the given Operator, set the given property to the given value.
    void setOperatorProperty(const std::string &operatorName, const std::string &propertyName, const std::string &value) ;

#ifndef DOXYGEN_SKIP
    /// Gets a process image dump
    void getdump() ;

    /// force an exception
    void takeException() ;
#endif

    /// Adds an application to the default container
    ///
    /// @param application a string containing the text of an application EventFlow, StreamSQL or binary of a sbar file
    /// @deprecated
    void modifyApplication(const std::string &application);

    /// Add an application to the given container
    ///
    /// @param containerName the name of the container to add this to
    /// @param applicationText binary content from a <code>.sbar</code> file, xml from an EventFlow application, or StreamSQL text. The character set is assumed UTF-8.
    /// @param options a list of options for the added container.  Run "sbadmin addContainer --help" for a complete list. 
    /// @return results if any 
    std::vector<std::string> addContainer(const std::string &containerName, const std::string &applicationText, const std::vector<std::string> &options);


    /// Add a deploy file to the server
    ///
    /// @param deployText binary content from a <code>.sbar</code> file, or xml from an <code>.sbdeploy</code> file. The character set is assumed UTF-8.
    /// @param options a list of options. Currently only supports --verbose as an argument 
    /// @return results if any 
    std::vector<std::string>  addDeploy(const std::string &applicationText, 
                                        const std::vector<std::string> &options = std::vector<std::string>());

    /// Remove a container
    ///
    /// @param containerName the name of the container to add this to
    /// @param options a list of options. Currently only supports --verbose as an argument 
    /// @return results if any 
    std::vector<std::string> removeContainer(const std::string &containerName, 
                                             const std::vector<std::string> &options = std::vector<std::string>());

    ///
    /// Modify the given container
    /// @param containerName containerName the container name to modify
    /// @param options a list of options to modify a container.  Run "sbadmin modifyContainer --help" for a complete list. 
    /// @return results if any 
    std::vector<std::string> modifyContainer(const std::string &containerName, const std::vector<std::string> &options);

    /// Lists all Connections to the StreamBaseServer
    ///
    /// @param result the result
    /// @param option
    void listConnections(std::vector<std::string>& result, const std::vector<std::string> &option = std::vector<std::string>());

    /// Kill the connection with the given connectionId
    ///
    void killConnection(const std::string &connectionId, std::vector<std::string> &status);

    /// Kill all connected clients
    void killAllConnections(std::vector<std::string> &status);

    /// Manage JDBC connections
    std::vector<std::string> manageJdbcConnections(const std::vector<std::string> &options);

#ifndef DOXYGEN_SKIP
    /// 
    /// Modify a runtime parameter for one, or all, operators.  Changes all
    /// operators if operatorName is omitted.
    void setRuntimeParam(const std::string &paramName, const std::string &paramValue, 
            const std::string &operatorName = "");
#endif //DOXYGEN_SKIP

    /// Get the leadership status of the server.
    /// @throws StreamBaseException 
    LeadershipStatus getLeadershipStatus();

    /// Set the leadership status of the server.
    /// @param leadershipStatus
    /// @throws StreamBaseException 
    void setLeadershipStatus(LeadershipStatus leadershipStatus);

    /// Drains the application: waits until there are no more tuples at
    /// all in the application and then shuts the application.  Blocks until
    /// this is complete.  
    /// has no effect if the server is not running
    void drain(const std::string &containerName) ;

    ///
    /// Get the settings for the client
    ///
    sb::ClientSettings &getSettings() {
        return _clientSettings;
    }

  private:
    void init();
    // No copying.
    StreamBaseAdminClient(const StreamBaseAdminClient&);

    // No copying.
    StreamBaseAdminClient& operator = (const StreamBaseAdminClient&);

    std::vector<StreamBaseURI> _uris;
    std::shared_ptr<sb_internal::Admin> _admin;
    sb::ClientSettings _clientSettings;
};


SB_NAMESPACE_END;
#endif