com.ibm.streams.management.instance

Interface InstanceMXBean

    • Field Detail

      • TYPE

        static final java.lang.String TYPE
        TYPE is used to identify this bean as an instance bean when building the bean's ObjectName. The value is "domain.instance"
        See Also:
        Constant Field Values
      • PROPERTY_GROUP_TYPE

        static final java.lang.String PROPERTY_GROUP_TYPE
        PROPERTY_GROUP_TYPE is used when building the ObjectName for an instance property group bean. The value is "domain.instance.propertygroup"
        See Also:
        Constant Field Values
    • Method Detail

      • getActiveVersion

        VersionInformation getActiveVersion()
        Returns information about the version of Streams code running for the instance
        Returns:
        the Streams version information
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getApplicationBundlesPath

        java.lang.String getApplicationBundlesPath()
        Returns the value of the APPLICATION_BUNDLES_PATH configuration property.
        Returns:
        the application bundles path.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setApplicationBundlesPath

        void setApplicationBundlesPath(java.lang.String bundlesPath)
        Sets the value of the APPLICATION_BUNDLES_PATH configuration property.
        Parameters:
        bundlesPath - specifies the new application bundles path to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getApplicationConfigurationNames

        java.util.Set<java.lang.String> getApplicationConfigurationNames()
        Returns the names of all application configuration stores for which the current user has read permission.
        Returns:
        the application configuration store names.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        ApplicationConfiguration, makeApplicationConfiguration(String, String, Map, String)
      • getApplicationCurrentWorkingPath

        java.lang.String getApplicationCurrentWorkingPath()
        Returns the value of the APPLICATION_CURRENT_WORKING_PATH configuration property.
        Returns:
        the application current working path.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setApplicationCurrentWorkingPath

        void setApplicationCurrentWorkingPath(java.lang.String workingPath)
        Sets the value of the APPLICATION_CURRENT_WORKING_PATH configuration property.
        Parameters:
        workingPath - specifies the new application working path to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getApplicationEnvironmentVariables

        java.util.Map<java.lang.String,java.lang.String> getApplicationEnvironmentVariables()
        Returns all application environment variables defined for the instance. An application environment variable is an environment variable that is required to be set when an application is run. When a job is submitted, Streams sets these environment variables so they are available to the job when it is running.
        Returns:
        the application environment variables
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getApplicationNetwork

        java.lang.String getApplicationNetwork()
        Returns the value of the APPLICATION_NETWORK configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the application network
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setApplicationNetwork

        void setApplicationNetwork(java.lang.String applicationNetwork)
        Sets the value of the APPLICATION_NETWORK configuration property.
        Parameters:
        applicationNetwork - specifies the new application network value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • isApplicationOnManagementResourceAllowed

        boolean isApplicationOnManagementResourceAllowed()
        Returns the value of the InstanceMXBean.PropertyId.APPLICATION_ON_MANAGEMENT_RESOURCE_ALLOWED configuration property.
        Returns:
        the application on management resource allowed indicator.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setApplicationOnManagementResourceAllowed

        void setApplicationOnManagementResourceAllowed(boolean applicationOnManagementAllowed)
        Sets the value of the InstanceMXBean.PropertyId.APPLICATION_ON_MANAGEMENT_RESOURCE_ALLOWED configuration property.
        Parameters:
        applicationOnManagementAllowed - specifies the new application on management resource allowed indicator to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getApplicationResourceAllocationMode

        DomainMXBean.ApplicationResourceAllocationMode getApplicationResourceAllocationMode()
        Returns the value of the InstanceMXBean.PropertyId.APPLICATION_RESOURCE_ALLOCATION_MODE configuration property.
        Returns:
        the default application resource allocation mode.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setApplicationResourceAllocationMode

        void setApplicationResourceAllocationMode(DomainMXBean.ApplicationResourceAllocationMode allocationMode)
        Sets the value of the InstanceMXBean.PropertyId.APPLICATION_RESOURCE_ALLOCATION_MODE configuration property.
        Parameters:
        allocationMode - specifies the new default application resource allocation mode to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getApplicationUmask

        java.lang.Integer getApplicationUmask()
        Returns the value of the APPLICATION_UMASK configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the application umask.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setApplicationUmask

        void setApplicationUmask(java.lang.Integer umask)
        Sets the value of the APPLICATION_UMASK configuration property.
        Parameters:
        umask - specifies the new umask value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getCanSetPeOSCapabilities

        boolean getCanSetPeOSCapabilities()
        Returns the value of the CAN_SET_PE_OS_CAPABILITIES configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the set processing element operating system capabilities indicator.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setCanSetPeOSCapabilities

        void setCanSetPeOSCapabilities(boolean setCapabilities)
        Sets the value of the CAN_SET_PE_OS_CAPABILITIES configuration property.
        Parameters:
        setCapabilities - indicates whether processing elements for a job within the instance are allowed to be set with operating system capabilities
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getCheckpointRepository

        DomainMXBean.CheckpointRepository getCheckpointRepository()
        Returns the value of the CHECKPOINT_REPOSITORY configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the checkpoint repository.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setCheckpointRepository

        void setCheckpointRepository(DomainMXBean.CheckpointRepository repository)
        Sets the value of the CHECKPOINT_REPOSITORY configuration property.
        Parameters:
        repository - specifies the new checkpoint repository value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getCheckpointRepositoryConfiguration

        java.lang.String getCheckpointRepositoryConfiguration()
        Returns the value of the CHECKPOINT_REPOSITORY_CONFIGURATION configuration property.
        Returns:
        the checkpoint repository configuration information.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setCheckpointRepositoryConfiguration

        void setCheckpointRepositoryConfiguration(java.lang.String configuration)
        Sets the value of the CHECKPOINT_REPOSITORY_CONFIGURATION configuration property.
        Parameters:
        configuration - specifies the new repository configuration value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getConfigurationVersion

        int getConfigurationVersion()
        Returns the value of the CONFIGURATION_VERSION configuration property.
        Returns:
        the version of the configuration data.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getCreationTime

        long getCreationTime()
        Returns the value of the CREATION_TIME configuration property.
        Returns:
        the instance creation time.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getCreationUser

        java.lang.String getCreationUser()
        Returns the value of the CREATION_USER configuration property.
        Returns:
        the user who created the instance.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getDomain

        java.lang.String getDomain()
        Returns the name of the domain in which the instance was created.
        Returns:
        the domain name.
      • isDynamicResourceAllocationEnabled

        boolean isDynamicResourceAllocationEnabled()
        Returns the value of the InstanceMXBean.PropertyId.DYNAMIC_RESOURCE_ALLOCATION_ENABLED configuration property.
        Returns:
        the dynamic resource allocation enabled indicator.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setDynamicResourceAllocationEnabled

        void setDynamicResourceAllocationEnabled(boolean dynamicResourceAllocationEnabled)
        Sets the value of the InstanceMXBean.PropertyId.DYNAMIC_RESOURCE_ALLOCATION_ENABLED configuration property.
        Parameters:
        dynamicResourceAllocationEnabled - specifies the new dynamic resource allocation enabled indicator to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getDynamicThreadingElastic

        java.lang.Boolean getDynamicThreadingElastic()
        Returns the value of the DYNAMIC_THREADING_ELASTIC configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        whether PEs should dynamically adapt the number of threads when the THREADING_MODEL is DYNAMIC.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setDynamicThreadingElastic

        void setDynamicThreadingElastic(java.lang.Boolean dynamicThreadingElastic)
        Sets the value of the DYNAMIC_THREADING_ELASTIC configuration property.
        Parameters:
        dynamicThreadingElastic - specifies the new value to set for the dynamically adapt PE thread count indicator.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html See InstanceMXBean.PropertyId.THREADING_MODEL
      • getDynamicThreadingThreadCount

        java.lang.Integer getDynamicThreadingThreadCount()
        Returns the value of the DYNAMIC_THREADING_THREAD_COUNT configuration property.
        Returns:
        the initial number of threads to create in a PE thread pool.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html See InstanceMXBean.PropertyId.THREADING_MODEL
      • setDynamicThreadingThreadCount

        void setDynamicThreadingThreadCount(java.lang.Integer threadCount)
        Sets the value of the DYNAMIC_THREADING_THREAD_COUNT configuration property.
        Parameters:
        threadCount - specifies the new initial number of threads to create in a PE thread pool.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html See InstanceMXBean.PropertyId.THREADING_MODEL
      • getFusionScheme

        DomainMXBean.FusionScheme getFusionScheme()
        Returns the value of the FUSION_SCHEME configuration property.
        Returns:
        the fusion scheme.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setFusionScheme

        void setFusionScheme(DomainMXBean.FusionScheme fusionScheme)
        Sets the value of the FUSION_SCHEME configuration property.
        Parameters:
        fusionScheme - specifies the new fusion scheme value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • isGovernanceEnabled

        boolean isGovernanceEnabled()
        Returns the value of the GOVERNANCE_ENABLED configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the governance indicator.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html See getGovernanceUrl()
      • setGovernanceEnabled

        void setGovernanceEnabled(boolean governanceEnabled)
        Sets the value of the GOVERNANCE_ENABLED configuration property.
        Parameters:
        governanceEnabled - specifies the new governance indicator to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getGovernanceUrl

        java.lang.String getGovernanceUrl()
        Returns the value of the GOVERNANCE_URL configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the governance URL.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html See isGovernanceEnabled()
      • setGovernanceUrl

        void setGovernanceUrl(java.lang.String url)
        Sets the value of the GOVERNANCE_URL configuration property.

        Note: Attribute change notification is supported for this attribute.

        Parameters:
        url - specifies the governance URL value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getGroups

        java.util.Set<java.lang.String> getGroups()
        Returns the set of user groups for which specific permissions are defined for at least one secured instance object, and user groups in roles for which the role has permissions defined in the instance.
        Returns:
        user groups with defined permissions.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getHighAvailabiltyCount

        int getHighAvailabiltyCount()
        Returns the value of the HIGH_AVAILABILITY_COUNT configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the high availability count.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setHighAvailabiltyCount

        void setHighAvailabiltyCount(int availabilityCount)
        Sets the value of the HIGH_AVAILABILITY_COUNT configuration property.
        Parameters:
        availabilityCount - specifies the new high availability count value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getJobGroups

        java.util.Set<java.lang.String> getJobGroups()
        Returns the set of job groups in the instance. A job group is used to configure the permissions to the instance objects used by a job. The job group for a job is specified when the job is submitted. If no value is specified the default job group for the instance is used.
        Returns:
        the set of instance job groups.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        submitJob(String, Map, Map, boolean, String, String, String), createJobGroup(String), SecuredObjectManagerMXBean
      • getJobResourceSharing

        DomainMXBean.JobResourceSharing getJobResourceSharing()
        Returns the value of the InstanceMXBean.PropertyId.JOB_RESOURCE_SHARING configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the default job resource sharing.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setJobResourceSharing

        void setJobResourceSharing(DomainMXBean.JobResourceSharing share)
        Sets the value of the InstanceMXBean.PropertyId.JOB_RESOURCE_SHARING configuration property.
        Parameters:
        share - the new job resource sharing to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getJobs

        java.util.Set<java.math.BigInteger> getJobs()
        Returns the set of active jobs for the instance for which the current user has read permission.
        Returns:
        the active jobs for the current user
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • isJvmSizeComputationEnabled

        boolean isJvmSizeComputationEnabled()
        Returns the value of the JVM_SIZE_COMPUTATION_ENABLED configuration property.
        Returns:
        the JVM size computation enabled indicator.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setJvmSizeComputationEnabled

        void setJvmSizeComputationEnabled(boolean computationEnabled)
        Sets the value of the JVM_SIZE_COMPUTATION_ENABLED configuration property.
        Parameters:
        computationEnabled - specifies the new JVM size computation enabled indicator to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getManagementResourceAllocationTags

        java.util.Set<java.lang.String> getManagementResourceAllocationTags()
        Returns the value of the MANAGEMENT_RESOURCE_ALLOCATION_TAGS configuration property.
        Returns:
        the resource tags used to request an instance management resource.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setManagementResourceAllocationTags

        void setManagementResourceAllocationTags(java.util.Set<java.lang.String> tags)
        Sets the value of the MANAGEMENT_RESOURCE_ALLOCATION_TAGS configuration property.
        Parameters:
        tags - specifies the new management resource allocation tags to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getName

        java.lang.String getName()
        Returns the unique identifier for the instance within the domain.
        Returns:
        the instance identifier.
      • getPlacementScheme

        DomainMXBean.PlacementScheme getPlacementScheme()
        Returns the value of the PLACEMENT_SCHEME configuration property.
        Returns:
        the default placement scheme.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setPlacementScheme

        void setPlacementScheme(DomainMXBean.PlacementScheme placementScheme)
        Sets the value of the PLACEMENT_SCHEME configuration property.
        Parameters:
        placementScheme - specifies the new default placement scheme value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getPreloadApplicationBundles

        boolean getPreloadApplicationBundles()
        Returns the value of the PRELOAD_APPLICATION_BUNDLES configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the preload application bundles indicator.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setPreloadApplicationBundles

        void setPreloadApplicationBundles(boolean preload)
        Sets the value of the PRELOAD_APPLICATION_BUNDLES configuration property.
        Parameters:
        preload - specifies the new preload application bundles value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getProposedOperatorsPerResource

        int getProposedOperatorsPerResource()
        Returns the value of the InstanceMXBean.PropertyId.PROPOSED_OPERATORS_PER_RESOURCE configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the default proposed number of operators per resource.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setProposedOperatorsPerResource

        void setProposedOperatorsPerResource(int operatorsPerResource)
        Sets the value of the InstanceMXBean.PropertyId.PROPOSED_OPERATORS_PER_RESOURCE configuration property.
        Parameters:
        operatorsPerResource - the new default proposed number of operators per resource to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getRepositoryConfigurationApplicationCache

        java.lang.String getRepositoryConfigurationApplicationCache()
        Returns the value of the REPOSITORY_CONFIGURATION_APPLICATION_CACHE configuration property.
        Returns:
        the application cache repository configuration information.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setRepositoryConfigurationApplicationCache

        void setRepositoryConfigurationApplicationCache(java.lang.String configuration)
        Sets the value of the REPOSITORY_CONFIGURATION_APPLICATION_CACHE configuration property.
        Parameters:
        configuration - specifies the new application cache repository configuration value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getResourceCpuUsageLowerThreshold

        int getResourceCpuUsageLowerThreshold()
        Returns the value of the InstanceMXBean.PropertyId.RESOURCE_CPU_USAGE_LOWER_THRESHOLD configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the default lower threshold for resource CPU usage.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setResourceCpuUsageLowerThreshold

        void setResourceCpuUsageLowerThreshold(int lowerThreshold)
        Sets the value of the InstanceMXBean.PropertyId.RESOURCE_CPU_USAGE_LOWER_THRESHOLD configuration property.
        Parameters:
        lowerThreshold - the new default lower threshold for resource CPU usage to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getResourceCpuUsageUpperThreshold

        int getResourceCpuUsageUpperThreshold()
        Returns the value of the InstanceMXBean.PropertyId.RESOURCE_CPU_USAGE_UPPER_THRESHOLD configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the default upper threshold for resource CPU usage.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setResourceCpuUsageUpperThreshold

        void setResourceCpuUsageUpperThreshold(int upperThreshold)
        Sets the value of the InstanceMXBean.PropertyId.RESOURCE_CPU_USAGE_UPPER_THRESHOLD configuration property.
        Parameters:
        upperThreshold - the new default upper threshold for resource CPU usage to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • isResourceLoadProtectionEnabled

        boolean isResourceLoadProtectionEnabled()
        Returns the value of the RESOURCE_LOAD_PROTECTION_ENABLED configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the resource load protection indicator.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html See getResourceLoadThreshold()
      • setResourceLoadProtectionEnabled

        void setResourceLoadProtectionEnabled(boolean protectionEnabled)
        Sets the value of the RESOURCE_LOAD_PROTECTION_ENABLED configuration property.
        Parameters:
        protectionEnabled - specifies the new resource load protection indicator to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getResourceLoadThreshold

        int getResourceLoadThreshold()
        Returns the value of the RESOURCE_LOAD_THRESHOLD configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the resource load threshold.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html See isResourceLoadProtectionEnabled()
      • setResourceLoadThreshold

        void setResourceLoadThreshold(int threshold)
        Sets the value of the RESOURCE_LOAD_THRESHOLD configuration property.

        Note: Attribute change notification is supported for this attribute.

        Parameters:
        threshold - specifies the new resource load threshold value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getResourceMemoryUsageLowerThreshold

        int getResourceMemoryUsageLowerThreshold()
        Returns the value of the InstanceMXBean.PropertyId.RESOURCE_MEMORY_USAGE_LOWER_THRESHOLD configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the default lower threshold for resource memory usage.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setResourceMemoryUsageLowerThreshold

        void setResourceMemoryUsageLowerThreshold(int lowerThreshold)
        Sets the value of the InstanceMXBean.PropertyId.RESOURCE_MEMORY_USAGE_LOWER_THRESHOLD configuration property.
        Parameters:
        lowerThreshold - the new default lower threshold for resource memory usage to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getResourceMemoryUsageUpperThreshold

        int getResourceMemoryUsageUpperThreshold()
        Returns the value of the InstanceMXBean.PropertyId.RESOURCE_MEMORY_USAGE_UPPER_THRESHOLD configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the default upper threshold for resource memory usage.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setResourceMemoryUsageUpperThreshold

        void setResourceMemoryUsageUpperThreshold(int upperThreshold)
        Sets the value of the InstanceMXBean.PropertyId.RESOURCE_MEMORY_USAGE_UPPER_THRESHOLD configuration property.
        Parameters:
        upperThreshold - the new default upper threshold for resource memory usage to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getResourceNetworkBandwidthUsageLowerThreshold

        int getResourceNetworkBandwidthUsageLowerThreshold()
        Returns the value of the InstanceMXBean.PropertyId.RESOURCE_NETWORK_BANDWIDTH_USAGE_LOWER_THRESHOLD configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the default lower threshold for resource network bandwidth usage.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setResourceNetworkBandwidthUsageLowerThreshold

        void setResourceNetworkBandwidthUsageLowerThreshold(int lowerThreshold)
        Parameters:
        lowerThreshold - the new default lower threshold for resource network bandwidth usage to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getResourceNetworkBandwidthUsageUpperThreshold

        int getResourceNetworkBandwidthUsageUpperThreshold()
        Returns the value of the InstanceMXBean.PropertyId.RESOURCE_NETWORK_BANDWIDTH_USAGE_UPPER_THRESHOLD configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the default upper threshold for resource network bandwidth usage.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setResourceNetworkBandwidthUsageUpperThreshold

        void setResourceNetworkBandwidthUsageUpperThreshold(int upperThreshold)
        Parameters:
        upperThreshold - the new default upper threshold for resource network bandwidth usage to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getResources

        java.util.Set<java.lang.String> getResources()
        Returns the set of resource identifiers for all resources available to the instance for running applications and services.
        Returns:
        the resource identifiers for all instance resources.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        StreamsHostResourceManagerMXBean.addInstanceHost(String, String, String)
      • getResourceSpecifications

        java.util.List<ResourceSpecification> getResourceSpecifications()
        Returns the set of resource specifications defined for the instance. A resource specification is used to specify the number of resources to add to an instance without having to supply specific resource identifiers. A resource specification can also optionally include a set of resource tags the resources must have and whether the resources must be exclusive to the instance. Resource specifications can be specified with an instance is created or they can be added at a later time.
        Returns:
        List - order is the order of evaluation
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        DomainMXBean.makeInstance(String, String, String, Map, List, String), addResourceSpecification(ResourceSpecification, String)
      • getRestartPesOnResourceFailure

        boolean getRestartPesOnResourceFailure()
        Returns the value of the RESTART_PES_ON_RESOURCE_FAILURE configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the restart PEs on resource failure indicator.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setRestartPesOnResourceFailure

        void setRestartPesOnResourceFailure(boolean restart)
        Sets the value of the RESTART_PES_ON_RESOURCE_FAILURE configuration property.
        Parameters:
        restart - specifies the new restart PEs on resource failure indicator to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getRestartPesOnResourceFailureWaitTime

        int getRestartPesOnResourceFailureWaitTime()
        Returns the value of the RESTART_PES_ON_RESOURCE_FAILURE_WAIT_TIME configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the restart PEs on resource failure wait time.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setRestartPesOnResourceFailureWaitTime

        void setRestartPesOnResourceFailureWaitTime(int waitTime)
        Sets the value of the RESTART_PES_ON_RESOURCE_FAILURE_WAIT_TIME configuration property.
        Parameters:
        waitTime - specifies the new restart PEs on resource failure wait time value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getRoles

        java.util.Set<java.lang.String> getRoles()
        Returns the set of names of security roles defined for the instance. This includes roles defined by Streams as well as any user defined roles created for the instance.
        Returns:
        the security role names.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        createRole(String), RoleMXBean
      • getRunAsUser

        java.lang.String getRunAsUser()
        Returns the value of the RUN_AS_USER configuration property.

        Note: Attribute change notification is supported for this attribute.

        Returns:
        the user used to start services and processing elements when Streams is running as a system service.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setRunAsUser

        void setRunAsUser(java.lang.String user)
        Sets the value of the RUN_AS_USER configuration property.
        Parameters:
        user - specifies the user used to start services and processing elements when Streams is running as a system service.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getSecuredObjects

        java.util.Set<java.lang.String> getSecuredObjects()
        Returns the set of names for all secured instance objects.
        Returns:
        the secured object names
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        SecuredObjectManagerMXBean, Permissions
      • getServiceContainerInitialJvmSize

        java.lang.Integer getServiceContainerInitialJvmSize()
        Returns the value of the SERVICE_CONTAINER_INITIAL_JVM_SIZE configuration property.
        Returns:
        the initial memory to allocate to the instance service container.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setServiceContainerInitialJvmSize

        void setServiceContainerInitialJvmSize(java.lang.Integer jvmSize)
        Sets the value of the SERVICE_CONTAINER_INITIAL_JVM_SIZE configuration property.
        Parameters:
        jvmSize - specifies the new initial JVM size to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getServiceContainerMaximumJvmSize

        java.lang.Integer getServiceContainerMaximumJvmSize()
        Returns the value of the SERVICE_CONTAINER_MAXIMUM_JVM_SIZE configuration property.
        Returns:
        the maximum memory to allocate to the instance service container.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setServiceContainerMaximumJvmSize

        void setServiceContainerMaximumJvmSize(java.lang.Integer jvmSize)
        Sets the value of the SERVICE_CONTAINER_MAXIMUM_JVM_SIZE configuration property.
        Parameters:
        jvmSize - specifies the new maximum JVM size to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getServices

        java.util.Set<InstanceServiceMXBean.Type> getServices()
        Returns the names of the Streams instance services.
        Returns:
        the instance service names.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getStartAsVersion

        java.lang.String getStartAsVersion()
        Returns the value of the START_AS_VERSION configuration property.
        Returns:
        the instance start version.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html See com.ibm.streams.management.domain.DomainMXBean.PropertyId.DETERMINE_INSTANCE_START_AS_VERSION
      • setStartAsVersion

        void setStartAsVersion(java.lang.String version)
        Sets the value of the START_AS_VERSION configuration property.
        Parameters:
        version - specifies the new instance start version to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html See com.ibm.streams.management.domain.DomainMXBean.PropertyId.DETERMINE_INSTANCE_START_AS_VERSION
      • getStartedByUser

        java.lang.String getStartedByUser()
        Returns the name of the user who started the instance. If the instance is not started, the value is null.
        Returns:
        the user name.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
      • getStartTime

        java.lang.Long getStartTime()
        Returns the time the instance was started as milliseconds since epoch. If the instance is not started, the value is null.
        Returns:
        the time the instance was started.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
      • getStatus

        InstanceMXBean.Status getStatus()
        Returns the current status of the instance. Attribute change notification is supported for the Status attribute.
        Returns:
        the instance status.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
      • getThreadingModel

        DomainMXBean.ThreadingModel getThreadingModel()
        Returns the value of the THREADING_MODEL configuration property.
        Returns:
        the PE threading model.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setThreadingModel

        void setThreadingModel(DomainMXBean.ThreadingModel threadingModel)
        Sets the value of the THREADING_MODEL configuration property.
        Parameters:
        threadingModel - specifies the new PE threading model value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getTransportSecurityType

        DomainMXBean.TransportSecurityType getTransportSecurityType()
        Returns the value of the TRANSPORT_SECURITY_TYPE configuration property.
        Returns:
        the security type used for data transport between processing elements.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setTransportSecurityType

        void setTransportSecurityType(DomainMXBean.TransportSecurityType securityType)
        Sets the value of the TRANSPORT_SECURITY_TYPE configuration property.
        Parameters:
        securityType - specifies the new transport security type value to set.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getUsers

        java.util.Set<java.lang.String> getUsers()
        Returns the set of Streams users for which specific permissions are defined for at least one secured instance object, and users in roles for which the role has permissions defined in the instance.
        Returns:
        user names with defined permissions.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • addApplicationEnvironmentVariable

        void addApplicationEnvironmentVariable(java.lang.String name,
                                               java.lang.String value)
        Adds an application environment variable to the instance configuration. This new application environment variable is only set for future job submissions and future PE restarts. See getApplicationEnvironmentVariables for more details.
        Parameters:
        name - specifies the name of the environment variable to add.
        value - specifies the value to set for the environment variable.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • addResourceSpecification

        java.lang.String addResourceSpecification(ResourceSpecification resourceSpecification,
                                                  java.lang.String listenerId)
        Adds a resource specification to the instance configuration. New resources are immediately added to the instance when the resource specification is added. See getResourceSpecifications for more details about resource specifications.
        Parameters:
        resourceSpecification - specifies the new resource specification to add.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Returns:
        the unique identifier for the resource specification within the instance.
        Throws:
        java.lang.IllegalArgumentException - if an operation listener does not exist for the specified listenerId.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if resourceSpecification is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • addRestrictedTags

        void addRestrictedTags(java.util.Set<java.lang.String> tags,
                               java.lang.String listenerId)
        Adds tag restrictions to the instance. Any subsequent dynamic resource allocation for the instance, with any of these tags specified, results in a tag restriction on the resource. This means only PEs that specify these tags are allowed to run on the resource.

        Notes:

        Parameters:
        tags - identifies the restricted instance tags to add.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.NullPointerException - if tags is null.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        removeRestrictedTags(Set, String), getRestrictedTags(), StreamsHostResourceManagerMXBean.restrictDomainHost(String, String, boolean)
      • cancelJob

        void cancelJob(java.math.BigInteger jobId,
                       boolean force)
        Cancels a running job. It optionally continues even if the processing elements cannot be stopped.
        Parameters:
        jobId - specifies the unique job identifier within the instance for the job to cancel.
        force - if true, continues with the cancel operation even if all PEs cannot be successfully stopped within the timeout period which is based on the value of InstanceMXBean.PropertyId HC_PEC_STOP_TIMEOUT.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • changeApplicationConfigurationDescription

        void changeApplicationConfigurationDescription(java.lang.String name,
                                                       java.lang.String description,
                                                       java.lang.String listenerId)
        Updates the description of an application configuration store.
        Parameters:
        name - identifies the name of the application configuration store to change. The value is case sensitive.
        description - contains the new description.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        ApplicationConfiguration, makeApplicationConfiguration(String, String, Map, String), changeApplicationConfigurationProperties(String, Map, String)
      • changeApplicationConfigurationProperties

        void changeApplicationConfigurationProperties(java.lang.String name,
                                                      java.util.Map<java.lang.String,java.lang.String> properties,
                                                      java.lang.String listenerId)
        Adds or updates entries in an application configuration store.
        Parameters:
        name - identifies the name of the application configuration store to change. The value is case sensitive.
        properties - contains the new content to store. The property names are case sensitive.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name or properties is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        ApplicationConfiguration, makeApplicationConfiguration(String, String, Map, String), removeApplicationConfigurationProperties(String, Set, String)
      • changeApplicationEnvironmentVariable

        void changeApplicationEnvironmentVariable(java.lang.String name,
                                                  java.lang.String value)
        Change the value for an application environment variable in the instance configuration. The change only affects future job submissions and PE restarts. If the application environment variable does not exist in instance configuration, an IllegalStateException is thrown. See getApplicationEnvironmentVariables for more details.
        Parameters:
        name - specifies the name of the application environment variable for which the configured value should change.
        value - specifies the new value for the application environment variable.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • changeResourceSpecification

        void changeResourceSpecification(ResourceSpecification resourceSpecification)
        Changes an existing resource specification for the instance. When you update this property value, the change does not occur until the instance restarts. If a resource specification does not exist with the specified identifier, an IllegalStateException is thrown. See getResourceSpecifications for more details about resource specifications.
        Parameters:
        resourceSpecification - specifies the resource specification to update and the new values to set for it.
        Throws:
        java.lang.IllegalStateException - if the resource specification does not exist or if the operation is unable to complete successfully.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if resourceSpecification is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • createJobGroup

        java.lang.String createJobGroup(java.lang.String jobGroup)
        Creates a new job group for the instance. See getJobGroups for more details about job groups.
        Parameters:
        jobGroup - identifies the name of the job group to create. This name must be unique within the instance.
        Returns:
        the secured object name of the created group.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if jobGroup is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • createOperationListener

        javax.management.ObjectName createOperationListener()
        Creates an OperationListenerMXBean for tracking status messages associated with operations invoked on this bean. Once the operation listener is created, the listener Id can be passed as a parameter on operations which support it. An operation listener can be reused for multiple operation invocations; however, the behavior is undefined if it is used for concurrent operations. All existing messages are cleared at the start of each operation for which the listener is used. The unregister operation should be called on the operation listener after the listener is no longer needed to free the associated memory. All operation listeners are automatically unregistered when the monitored bean is unregistered. An operation listener is also automatically unregistered if it has had no activity for a certain amount of time. The inactivity time is controlled by the JMX_INACTIVITY_TIMEOUT property and is set to 30 minutes by default. If an operation listener bean is needed again, a new one can be created.
        Returns:
        the object name of the created listener bean.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
      • createRole

        javax.management.ObjectName createRole(java.lang.String role)
        Create a security role for assigning identical permissions to secured domain objects for multiple users or groups of users.
        Parameters:
        role - identifies the name of the role to create. Role names must be unique within the instance.
        Returns:
        the object name of the managed bean for the created role.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if role is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        RoleMXBean
      • deleteJobGroup

        void deleteJobGroup(java.lang.String jobGroup)
        Deletes a job group from an instance. All jobs belonging to the job group must be canceled before you can delete the job group. Deleting the default job group is not supported. See getJobGroups for more details about job groups.
        Parameters:
        jobGroup - identifies the job group to delete.
        Throws:
        java.lang.NullPointerException - if level is null.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • deleteRole

        void deleteRole(java.lang.String role)
        Deletes an instance security role. Deleting a security role defined by Streams is not supported. When a role is deleted, all permissions defined for that role are also removed.
        Parameters:
        role - identifies the name of the role to delete.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if role is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • deployApplication

        DeployInformation deployApplication(java.lang.String bundleFileName)
        Initiates the deployment of an application so it can be run or so a preview of the job configuration overlay can be generated.
        Parameters:
        bundleFileName - specifies the name of the bundle file to deploy, excluding the path. For example, sample.Vwap.sab
        Returns:
        a DeployInformation object containing HTTPS URIs and an application identifier.

        To complete the deploy operation, perform an HTTP PUT of the bundle using the URI returned by getUri(). The content type on the PUT must be set to application/x-jar.

        Input job configuration overlay information can also optionally be supplied as part of the deploy operation by doing an HTTP PUT using the URI returned by getOperatorConfigurationUri(). If this is done, it must be done before the HTTP PUT for the application bundle. The content type on the PUT must be set to application/json. The format of this configuration information can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.2.5/com.ibm.streams.dev.doc/doc/dev_job_configuration_overlays.html

        After completing the deploy operation, the application can be run or a preview of the job configuration overlay can be generated by passing the returned application identifier on a submitJob call or on a previewSubmitJob call.

        Note: The application is deployed temporarily. If it is not submitted within a minute after the deploy completes, it is held in the application cache repository for four hours. If the application is submitted, it is held in the application cache repository while the job is running and remains in the cache for four hours after the job stops running.

        Throws:
        java.lang.IllegalArgumentException - if the bundleFileName does not end in .sab or it contains a slash character.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if bundleFileName is null.
      • deployApplication

        ContentTransfer deployApplication(java.lang.String bundleFileName,
                                          java.lang.String bundleBuildId)
        Initiates the deployment of an application so it can be run or so a preview of the job configuration overlay can be generated. This operation checks first to see if the application bundle is already stored in the application cache repository.
        Parameters:
        bundleFileName - specifies the name of the bundle file to deploy, excluding the path. For example, sample.Vwap.sab
        bundleBuildId - specifies the build identifier of the bundle file to deploy. If this value is null, no check is made to see if the application bundle is already stored in the application cache repository.
        Returns:
        a ContentTransfer object containing a list of HTTPS URIs and an application identifier. To complete the deploy operation, perform an HTTP PUT to each URI returned as described below. The retuned URIs, by list index, are as follows:
        • 0 - the URI to use to perform an HTTP PUT of the application bundle. The content type on the PUT must be set to application/x-jar. If this URI is empty, an HTTP PUT of the application bundle is not needed since the bundle already exists in the application cache respository.
        • 1 - the URI to use to perform an HTTP PUT of the job configuration overlay as part of the deploy operation. Providing the job configuration overlay is optional, but if it is done it must be done before the HTTP PUT for the application bundle or the HTTP PUT for the deploy completion signal. The content type on the PUT for the job configuration overlay must be set to application/json. The format of this configuration information can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.2.5/com.ibm.streams.dev.doc/doc/dev_job_configuration_overlays.html
        • 2 - the URI to use to perform an HTTP PUT signaling the deploy operation is complete. This must be the last HTTP PUT in the deploy process. The content type on the PUT must be set to text/plain. The content body must contain the the bundle build identifier. If this URI is empty, an HTTP PUT to signal completion is not needed.
        After completing the deploy operation, the application can be run or a preview of the job configuration overlay can be generated by passing the returned application identifier on a submitJob call or on a previewSubmitJob call.

        Note: The application is deployed temporarily. If it is not submitted within a minute after the deploy completes, it is held in the application cache repository for four hours. If the application is submitted, it is held in the application cache repository while the job is running and remains in the cache for four hours after the job stops running.

        Throws:
        java.lang.IllegalArgumentException - if the bundleFileName does not end in .sab or it contains a slash character.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if bundleFileName is null.
      • getApplicationConfiguration

        ApplicationConfiguration getApplicationConfiguration(java.lang.String name)
        Returns information about an application configuration and its contents.
        Parameters:
        name - identifies the name of the application configuration store for which information is returned. The value is case sensitive.
        Returns:
        application configuration store information and contents.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        ApplicationConfiguration, makeApplicationConfiguration(String, String, Map, String)
      • getJobId

        java.math.BigInteger getJobId(java.lang.String name)
        Returns the job identifier for the job with the specified name.
        Parameters:
        name - identifies the name of the job for which the identifier is returned. The value is case sensitive.
        Returns:
        the job identifier.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getPendingResourceSpecification

        ResourceSpecification getPendingResourceSpecification(java.lang.String id)
        Returns the pending configuration for a resource specification. Changes to a resource specification do not occur immediately after being updated; rather, the change is pending a restart of the instance. If a resource specification does not exist with the specified identifier or there are no pending changes for the resource specification, an IllegalStateException is thrown. See getResourceSpecifications for more details about resource specifications.
        Parameters:
        id - identifies the resource specification for which the pending configuration is retrieved.
        Returns:
        the pending resource specification information. For a pending delete, null is returned.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if id is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getPendingProperty

        java.lang.String getPendingProperty(InstanceMXBean.PropertyId id)
        Returns the pending value for a configuration property. Changes to some property do not occur immediately after being updated; rather, the change is pending a restart of the instance. The InstanceMXBean.PropertyId value descriptions identify the pending properties. If there is no pending value for the property, an IllegalStateException is thrown. For properties which have an enumeration for possible values, the fromString() method on the enumeration can be used to convert the returned value to an enumeration value.
        Parameters:
        id - identifies the property for which the pending value is retrieved.
        Returns:
        the pending property value. For a pending delete, null is returned.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if id is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getProperties

        java.util.Map<InstanceMXBean.PropertyId,java.lang.String> getProperties(boolean includePropertyGroups)
        Returns configuration property values for the instance. The results either include just the top-level instance property values or the values for all of the property groups can also be included. For properties which have an enumeration for possible values, the fromString() method on the enumeration can be used to convert the returned value to an enumeration value.
        Parameters:
        includePropertyGroups - specifies whether property group values are also included
        Returns:
        the instance property values
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        InstanceMXBean.PropertyGroup
      • getProperty

        java.lang.String getProperty(InstanceMXBean.PropertyId id)
        Returns the value of a configuration property. For properties which have an enumeration for possible values, the fromString() method on the enumeration can be used to convert the returned value to an enumeration value.
        Parameters:
        id - identifies the property value to return
        Returns:
        the configuration property value
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if id is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getResolvedPropertyDefault

        java.lang.String getResolvedPropertyDefault(InstanceMXBean.PropertyId id)
        Returns the resolved default value for a configuration property. Sometimes the default value for a property is inherited from the current value of another property. Sometimes the default value for a property contains substitution text. The resolved property default is the default value for a property after resolving the inherited value and performing text substitution as necessary. The definition of the property default behavior is part of the property metadata. For properties which have an enumeration for possible values, the fromString() method on the enumeration can be used to convert the returned value to an enumeration value.
        Parameters:
        id - identifies the property for which the resolved default is retrieved
        Returns:
        the resolved property default.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if id is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        retrievePropertyMetadata(PropertyId), isPropertyValueInherited(PropertyId)
      • getResourceSpecification

        ResourceSpecification getResourceSpecification(java.lang.String id)
        Returns the resource specification information for a resource specification configured for the instance. If a resource specification does not exist with the specified identifier, an IllegalStateException is thrown. See getResourceSpecifications for more details about resource specifications.
        Parameters:
        id - identifies the resource specification for which the configuration information is retrieved.
        Returns:
        the resource specification information.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if id is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • getRestrictedConfiguration

        java.lang.String getRestrictedConfiguration(java.lang.String name)
        Returns the value of the restricted configuration with the specified name.
        Parameters:
        name - identifies the restricted configuration for which the value is retrieved.
        Returns:
        the restricted configuration value.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name is null.
        java.lang.IllegalArgumentException - if name is blank.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        setRestrictedConfiguration(String, String), retrieveRestrictedConfigurations()
      • getSecuredObjects

        java.util.Set<java.lang.String> getSecuredObjects(SecuredObjectManagerMXBean.PermissionType permissionType)
        Returns the set of names for secured instance objects for which the current user has a specified permission type, whether it be from a user permission, a group permission, or permission assigned from a role.
        Parameters:
        permissionType - identifies the permission type to query.
        Returns:
        the set of secured object names
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if permissionType is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • isPropertyValueInherited

        boolean isPropertyValueInherited(InstanceMXBean.PropertyId id)
        Returns whether the value of a configuration property has been inherited from the current value of another property. When a property value is inherited from another property, changes to the inherited value are automatically reflected in the inheriting property. If a specific value is set for the property, it no longer changes when the inherited property changes. To resume the inheriting behavior, remove the specific value for the property.
        Parameters:
        id - identifies the property for which the inherited behavior is returned
        Returns:
        true if the current value is inherited from another property
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if id is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        removeProperty(InstanceMXBean.PropertyId)
      • isTagInUseByAnyJob

        boolean isTagInUseByAnyJob(java.lang.String tag)
        Returns whether any processing elements (PEs) placed on any resource within the instance require the specified resource tag.
        Parameters:
        tag - identifies the resource tag to query
        Returns:
        true if there is a placed PE requiring the resource tag.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if tag is null.
        See Also:
        ResourceTag
      • isTagInUseByInstance

        boolean isTagInUseByInstance(java.lang.String tag)
        Returns whether a resource tag is part of a resource specification for the instance.
        Parameters:
        tag - identifies the resource tag to query
        Returns:
        true if the resource tag is part of a resource specification for the instance.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if tag is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        ResourceSpecification, ResourceTag
      • makeApplicationConfiguration

        void makeApplicationConfiguration(java.lang.String name,
                                          java.lang.String description,
                                          java.util.Map<java.lang.String,java.lang.String> properties,
                                          java.lang.String listenerId)
        Creates a new application configuration store for secure storage and retrieval of name/value pairs.
        Parameters:
        name - identifies the name of the application configuration store to create. The value is case sensitive and must be unique within the instance.
        description - specifies a description to save with the application configuration store. This value can be null.
        properties - contains the contents to save in the application configuration store. The property names are case sensitive.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name or properties is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        ApplicationConfiguration, removeApplicationConfiguration(String, String), changeApplicationConfigurationProperties(String, Map, String)
      • previewSubmitJob

        java.lang.String previewSubmitJob(java.lang.String applicationId,
                                          java.util.Map<java.lang.String,java.lang.String> submitParameters,
                                          java.util.Map<java.lang.String,java.lang.String> configurationSettings,
                                          boolean overrideResourceLoadProtection,
                                          java.lang.String jobGroup,
                                          java.lang.String jobName,
                                          java.lang.String listenerId)
        Generates a preview of the job configuration overlay that would be used if the application is submitted with the specified parameters values and with the input job configuration overlay if job configuration overlay information was provided as part of the application deployment process. See deployApplication for more information on deploying applications. The generated job configuration overlay can optionally be modified as necessary and provided as input for subsequent submitJob or previewSubmitJob calls.
        Parameters:
        applicationId - Identifies the deployed application to run.
        submitParameters - contains the parameter names and corresponding values to set when the job is submitted or null if no parameters are needed.
        configurationSettings - contains the configuration settings to be used for the job submission or null if no settings are needed. The supported configuration settings are as follows:
        • data-directory specifies the location of the data directory. For example: /myDataDirectory.
        • fusionScheme specifies the scheme used to determine how to fuse an application's operators into PEs. See the FusionScheme enumeration for possible values. The toString() value of the enumeration value must be used as the setting value. If this setting is not specified and the fusionTargetPeCount setting is not specified, the value of PropertyId.FUSION_SCHEME is used.
        • fusionTargetPeCount specifies the target PE count when fusing operators. The actual PE count could be higher or lower than this value. It is an error if this setting is specified and another fusion setting is also specified.
        • preloadApplicationBundles specifies whether to preload the job onto all resources in the instance, even if it is not currently needed there. Valid values are true and false. Preloading the job can improve the performance if the PE is relocated to a new resource.
        • tracing specifies the trace setting for the PEs. Valid values are: error, warn, info, debug, and trace.
        overrideResourceLoadProtection - specifies whether to submit the job regardless of the load settings for the resource.
        jobGroup - identifies the job group to use in controlling permission to the submitted job. If a job group is not specified, the default job group is used.
        jobName - identifies a name to associate with the job. This name must be unique within the instance. If a name is not specified, a default name is generated.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Returns:
        an HTTPS URI to access the generated job configuration overlay. The content type of the configuration information is application/json. The format of this configuration information can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.2.5/com.ibm.streams.dev.doc/doc/dev_job_configuration_overlays.html

        This URI is valid for a single access for up to two minutes.
        Throws:
        java.lang.IllegalArgumentException - if a deployed application bundle does not exist for the specified applicationId or if an operation listener does not exist for the specified listenerId.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if applicationId is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • refreshPrincipalSecurityBeans

        void refreshPrincipalSecurityBeans()
        Updates the set of principal security beans to reflect the current set of principals which have specific permissions defined for at least one secured instance object. As permissions are added and removed for secured objects, the set of principal beans does not automatically reflect the changes. This operation synchronizes the principal bean set with the current permissions.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • registerJob

        javax.management.ObjectName registerJob(java.math.BigInteger jobId)
        Registers a managed bean for a job as well as managed beans for its related PEs, operators, connections, etc. The registration is done synchronously and the operation returns when it completes. If the job is already registered, this operation is seen as activity on the job. After a period of inactivity defined by the JMX_INACTIVITY_TIMEOUT configuration property, the INACTIVITY_WARNING notification is sent for the job bean. If there is no activity on any of the job-related beans within the next minute, the job bean and all of the related beans are unregistered and a INACTIVITY_UNREGISTER notification is sent for the job bean. Registering the job must be done before attempting to access any of the job-related beans. If a job is not registered the JOB_REMOVED notification is still sent when the job is canceled.
        Parameters:
        jobId - specifies the unique job identifier within the instance for the job to register.
        Returns:
        the object name of the registered managed bean for the job.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if jobId is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        registerJob(BigInteger, String), registerJobForPe(java.math.BigInteger), registerJobForPe(java.math.BigInteger, String), registerJobs(String, String), registerAllJobs(String)
      • registerJob

        void registerJob(java.math.BigInteger jobId,
                         java.lang.String listenerId)
        Registers a managed bean for a job as well as managed beans for its related PEs, operators, connections, etc. This operation returns immediately and the registration of the job is done asynchronously. Pass a listenerId parameter value to track the status of the registration. See registerJob for more details about job registration.
        Parameters:
        jobId - specifies the unique job identifier within the instance for the job to register.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalArgumentException - if an operation listener does not exist for the specified listenerId.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if jobId is null.
      • registerJob

        javax.management.ObjectName registerJob(java.lang.String jobName)
        Registers a managed bean for a job as well as managed beans for its related PEs, operators, connections, etc. The registration is done synchronously and the operation returns when it completes. See registerJob for more details about job registration. Note: the previously mentioned operation performs slightly better than this one since a job identifier lookup is not required.
        Parameters:
        jobName - specifies the unique job name within the instance for the job to register.
        Returns:
        the object name of the registered managed bean for the job.
        Throws:
        java.lang.IllegalArgumentException - if a job does not exist for the specified jobName.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if jobName is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        registerJob(String, String)
      • registerJob

        java.math.BigInteger registerJob(java.lang.String jobName,
                                         java.lang.String listenerId)
        Registers a managed bean for a job as well as managed beans for its related PEs, operators, connections, etc. This operation returns immediately and the registration of the job is done asynchronously. Pass a listenerId parameter value to track the status of the registration. See registerJob for more details about job registration. Note: registerJob(BigInteger, String) performs slightly better than this operation since a job identifier lookup is not required.
        Parameters:
        jobName - specifies the unique job name within the instance for the job to register.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Returns:
        the unique job identifier within the instance for the job to register.
        Throws:
        java.lang.IllegalArgumentException - if a job does not exist for the specified jobName or if an operation listener does not exist for the specified listenerId.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if jobName is null.
        See Also:
        registerJob(String)
      • registerJobForPe

        javax.management.ObjectName registerJobForPe(java.math.BigInteger peId)
        Registers a managed bean for the job containing a specified PE. Managed beans for the job's related PEs, operators, connections, etc. are also registered. The registration is done synchronously and the operation returns when it completes. See registerJob for more details about job registration.
        Parameters:
        peId - specifies the unique PE identifier within the instance which is part of the job to register.
        Returns:
        the object name of the registered managed bean for the job.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if peId is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        registerJobForPe(java.math.BigInteger, String)
      • registerJobForPe

        void registerJobForPe(java.math.BigInteger peId,
                              java.lang.String listenerId)
        Registers a managed bean for the job containing a specified PE. Managed beans for the job's related PEs, operators, connections, etc. are also registered. This operation returns immediately and the registration of the job is done asynchronously. Pass a listenerId parameter value to track the status of the registration. See registerJob for more details about job registration.
        Parameters:
        peId - specifies the unique PE identifier within the instance which is part of the job to register.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalArgumentException - if an operation listener does not exist for the specified listenerId.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if peId is null.
        See Also:
        registerJobForPe(java.math.BigInteger)
      • registerAllJobs

        void registerAllJobs(java.lang.String listenerId)
        Registers managed beans for all jobs for which the current user has read permission. This operation returns immediately and the registration of the jobs is done asynchronously. Pass a listenerId parameter value to track the status of the registration. See registerJob for more details about job registration.
        Parameters:
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalArgumentException - if an operation listener does not exist for the specified listenerId.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
      • registerJobs

        void registerJobs(java.lang.String jobGroup,
                          java.lang.String listenerId)
        Registers managed beans for all jobs belonging to a job group. This operation returns immediately and the registration of the jobs is done asynchronously. Pass a listenerId parameter value to track the status of the registration. See registerJob for more details about job registration.
        Parameters:
        jobGroup - identifies the job group for the jobs to register. If the value is null, the default job group is used.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalArgumentException - if an operation listener does not exist for the specified listenerId.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        See Also:
        getJobGroups()
      • remove

        void remove(java.lang.String listenerId)
        Removes the instance from the domain and deletes it. The instance must be stopped before it can be removed.
        Parameters:
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalArgumentException - if an operation listener does not exist for the specified listenerId.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • removeApplicationConfiguration

        void removeApplicationConfiguration(java.lang.String name,
                                            java.lang.String listenerId)
        Deletes an application configuration store and all of its contents.
        Parameters:
        name - identifies the name of the application configuration store to delete. The value is case sensitive.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        ApplicationConfiguration, makeApplicationConfiguration(String, String, Map, String)
      • removeApplicationConfigurationProperties

        void removeApplicationConfigurationProperties(java.lang.String name,
                                                      java.util.Set<java.lang.String> propertyNames,
                                                      java.lang.String listenerId)
        Removes entries from an application configuration store.
        Parameters:
        name - identifies the name of the application configuration store to modify. The value is case sensitive.
        propertyNames - contains the names of the entries to remove. The property names are case sensitive.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name or propertyNames is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        ApplicationConfiguration, makeApplicationConfiguration(String, String, Map, String), changeApplicationConfigurationProperties(String, Map, String)
      • removeApplicationEnvironmentVariable

        void removeApplicationEnvironmentVariable(java.lang.String name)
        Remove an application environment variable from the instance configuration. This change only affects future job submissions and PE restarts. If the application environment variable does not exist in instance configuration, this operation has no effect. See getApplicationEnvironmentVariables for more details.
        Parameters:
        name - specifies the name of the application environment variable to remove.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • removeGovernanceCredentials

        void removeGovernanceCredentials()
        Removes the user and password used by IBM Streams to connect to the IBM InfoSphere Information Governance Catalog server.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        setGovernanceCredentials(String, String)
      • removeProperty

        void removeProperty(InstanceMXBean.PropertyId id)
        Removes the current value for a configuration property, reverting it back to its default behavior. Changes to some property values do not occur immediately after being updated; rather the change is pending the restart of the instance. To determine which property changes require a domain restart see the InstanceMXBean.PropertyId value descriptions.
        Parameters:
        id - identifies the property for which the value is removed. *
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if id is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        getPendingProperty(InstanceMXBean.PropertyId)
      • removeResourceSpecification

        void removeResourceSpecification(java.lang.String id)
        Removes a resource specification from the instance. The removal does not occur until the instance restarts. If a resource specification does not exist with the specified identifier, an IllegalStateException is thrown. See getResourceSpecifications for more details about resource specifications.
        Parameters:
        id - id identifies the resource specification to remove.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if id is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • removeRestrictedConfiguration

        void removeRestrictedConfiguration(java.lang.String name)
        Deletes a restricted configuration.
        Parameters:
        name - identifies the restricted configuration to delete.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name is null.
        java.lang.IllegalArgumentException - if name is blank.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        setRestrictedConfiguration(String, String)
      • removeRestrictedTags

        void removeRestrictedTags(java.util.Set<java.lang.String> tags,
                                  java.lang.String listenerId)
        Removes tag restrictions from the instance. Tag restrictions on the instance are used to determine tag restrictions on resources dynamically added to the instance.
        Parameters:
        tags - identifies the tag restrictions to remove.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.NullPointerException - if tags is null.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        addRestrictedTags(Set, String), getRestrictedTags()
      • getRestrictedTags

        java.util.Set<java.lang.String> getRestrictedTags()
        Retrieves tag restrictions for the instance. Tag restrictions on the instance are used to determine tag restrictions on resources dynamically added to the instance.
        Returns:
        the instance tag restrictions.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        addRestrictedTags(Set, String), removeRestrictedTags(Set, String)
      • retrieveExportedStreams

        java.util.Map<javax.management.ObjectName,java.util.Set<javax.management.ObjectName>> retrieveExportedStreams()
        Returns the set of operator output ports with exported streams and the set of dynamic connections that currently exist for each.
        Returns:
        exporting operators and associated dynamic connections.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • retrieveImportedStreams

        java.util.Map<javax.management.ObjectName,java.util.Set<javax.management.ObjectName>> retrieveImportedStreams()
        Returns the set of operator input ports with imported streams and the set of dynamic connections that currently exist for each.
        Returns:
        importing operators and associated dynamic connections.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • retrieveJobHealthSummary

        InstanceMXBean.JobHealthSummary retrieveJobHealthSummary()
        Returns a summarized status of the jobs in the instance.
        Returns:
        the summarized job status.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • retrieveJobSystemMetricMetadata

        java.util.Set<MetricMetadata> retrieveJobSystemMetricMetadata()
        Returns information such as the: name, description, and kind for the job metrics defined by Streams.
        Returns:
        the system metric metadata.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
      • retrievePendingProperties

        java.util.Map<InstanceMXBean.PropertyId,java.lang.String> retrievePendingProperties()
        Returns all pending configuration property values. For pending delete requests, the value is null. See getPendingProperty for additional details.
        Returns:
        all pending configuration property changes.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • retrievePendingResourceSpecifications

        java.util.Map<java.lang.String,ResourceSpecification> retrievePendingResourceSpecifications()
        Returns all pending resource specification changes. For pending delete requests, the value is null. See getPendingResourceSpecification for additional details.
        Returns:
        all pending resource specification changes.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • retrievePeRestartPriorities

        java.util.Map<java.math.BigInteger,PeMXBean.RestartPriority> retrievePeRestartPriorities(int resourceLoadThreshold)
        Retrieves the recommended processing element (PE) restart priorities for PEs in this instance.
        Parameters:
        resourceLoadThreshold - specifies the resource threshold value to use when determining the priorities. The value is interpreted as follows:
        • greater than 0 - use the value exactly
        • 0, -1 or less than -3 - use the value specified in the instance configuration
        • -2 - use the average for all resources in the instance
        • -3 - use the middle resource average as the threshold
        Returns:
        the restart priorities for the PEs in the instance.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • retrievePropertyMetadata

        java.util.Map<InstanceMXBean.PropertyId,PropertyMetadata> retrievePropertyMetadata()
        Returns information about the definition of each domain configuration property, such as: type, default value, possible values, constraint type, whether it is read-only, whether changes are applies immediately, and whether its default value is inherited from another property value
        Returns:
        property metadata for all instance properties, including property group properties
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • retrievePropertyMetadata

        PropertyMetadata retrievePropertyMetadata(InstanceMXBean.PropertyId id)
        Returns information about the definition of an instance configuration property, such as: type, default value, possible values, constraint type, whether it is read-only, whether changes are applies immediately, and whether its default value is inherited from another property value
        Parameters:
        id - identifies the property for which the metadata is retrieved
        Returns:
        property metadata for a configuration property
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if id is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • retrieveResourceMetrics

        java.util.Map<java.lang.String,java.util.Set<Metric>> retrieveResourceMetrics(boolean includeDescriptions)
        Retrieves the metric values for the resources in the instance. A metric is a measurement of an element associated with the resource. The metric descriptions can optionally be included.
        Parameters:
        includeDescriptions - specifies whether metric descriptions are included with the values.
        Returns:
        the names of the resources in the instance and the set of metrics associated with each.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • retrieveRestrictedConfigurations

        java.util.Map<java.lang.String,java.lang.String> retrieveRestrictedConfigurations()
        Retrieves the names and values for all restricted configurations created for the instance.
        Returns:
        the restricted configuration names and values.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        setRestrictedConfiguration(String, String)
      • setGovernanceCredentials

        void setGovernanceCredentials(java.lang.String user,
                                      java.lang.String password)
        Sets the user and password used by IBM Streams to connect to the IBM InfoSphere Information Governance Catalog server. The default behavior is to use the values set by com.ibm.streams.management.domain.DomainMXBean.setGovernanceCredentials(String, String)
        Parameters:
        user - specifies a user ID to use for connecting to the governance server. At a minimum, the user must be an IBM InfoSphere Information Governance Catalog Information Asset Administrator.
        password - specifies the password for the governance user.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if user or password is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • setProperty

        void setProperty(InstanceMXBean.PropertyId id,
                         java.lang.String value)
        Updates the value of a configuration property. Changes to some property values do not occur immediately after being updated; rather the change is pending the restart of the instance. To determine which property changes require an instance restart see the InstanceMXBean.PropertyId value descriptions. For properties which have an enumeration for possible values, the toString() method on the enumeration value must be used for the value parameter on this call.
        Parameters:
        id - identifies the property for which the value is changed.
        value - specifies the new property value.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if level is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        getPendingProperty(InstanceMXBean.PropertyId)
      • setRestrictedConfiguration

        void setRestrictedConfiguration(java.lang.String name,
                                        java.lang.String value)
        Creates a new restricted cofiguration or updates the value of an existing one. A restricted configuration is a way to store sentitive configuration information associated with the instance. The restricted configuration value is stored encrypted to protect the sensitive information. Only instance administrators are able to work with restricted configurations.
        Parameters:
        name - identifies the name of the restricted configuration to create or update.
        value - specifies the value to store for the restricted configuration.
        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if name or value is null.
        java.lang.IllegalArgumentException - if name is blank.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        getRestrictedConfiguration(String), removeRestrictedConfiguration(String)
      • snapshotJobMetrics

        java.lang.String snapshotJobMetrics()
        Takes a current snapshot of the PE metrics for all jobs to which the current user has permission and returns an HTTPS URI to retrieve the results. This operation does not require the associated job beans to be registered.
        Returns:
        an HTTPS URI to access the metric values in application/json format. This URI is valid for a single access for up to two minutes.

        The metric values are provided in JSON format with a string id parameter containing the instance identifier and an array jobs parameter. Each item in the jobs array has the format documented by JobMXBean.snapshotMetrics.

        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • snapshotJobMetrics

        java.lang.String snapshotJobMetrics(java.util.Set<java.math.BigInteger> jobs)
        Takes a current snapshot of the PE metrics for all specified jobs and returns an HTTPS URI to retrieve the results. This operation does not require the associated job beans to be registered.
        Parameters:
        jobs - specifies the identifiers of the jobs for which the metrics are returned. If a specified job does not exist or the current user does have access to it, the job is skipped.
        Returns:
        an HTTPS URI to access the metric values in application/json format. This URI is valid for a single access for up to two minutes.

        The metric values are provided in JSON format with a string id parameter containing the instance identifier and an array jobs parameter. Each item in the jobs array has the format documented by JobMXBean.snapshotMetrics.

        Throws:
        java.lang.NullPointerException - if jobs is null.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • snapshotJobs

        java.lang.String snapshotJobs(java.util.Set<java.math.BigInteger> jobs,
                                      int maximumDepth,
                                      boolean includeStaticAttributes)
        Takes a current snapshot of the job attributes for all specified jobs and returns an HTTPS URI to retrieve the results. Attributes of descendant objects and static attributes can optionally be included. All specified jobs are registered if not previously registered.
        Parameters:
        jobs - specifies the identifiers of the jobs for which attributes are returned. If a specified job does not exist or the current user does have access to it, the job is skipped. If this parameter value is null, attributes for all jobs the current user can access are retrieved.
        maximumDepth - specifies which descendant object attributes should be included in the snapshot. Values are handled as follows:
        • less than zero - all descendant attributes are included.
        • zero - no descendant attributes are included.
        • one - only attributes for immediate child objects are included. Immediate children include: PEs. Note: the related domain, instance, and job attributes are not repeated for each PE.
        • greater than one - attributes for descendants are included up to the level specified.
        includeStaticAttributes - indicates whether static attributes should be included in the snapshot. A static attribute is a attribute that does not change and that is not an identifier attribute. A note is included in the attribute description for each attribute that is not included in the snapshot if includeStaticAttributes is false.
        Returns:
        an HTTPS URI to access the attribute values in application/json format. This URI is valid for a single access for up to two minutes.

        The attribute values are provided in JSON format with a string id parameter containing the instance identifier and an array jobs parameter. Each item in the jobs array has the format documented by JobMXBean.snapshot.

        Throws:
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • start

        void start(java.lang.String listenerId)
        Starts the instance. The instance is started using the version specified by the START_AS_VERSION property. If this property is not set, the active domain version is used.
        Parameters:
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalArgumentException - if an operation listener does not exist for the specified listenerId.
        java.lang.IllegalStateException - if the instance is already started or if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        start(String, String)
      • start

        void start(java.lang.String version,
                   java.lang.String listenerId)
        Starts the instance using a specified installed Streams version. This version overrides any version specified by the START_AS_VERSION property.
        Parameters:
        version - specifies the version of Streams to use when starting the instance. The format of the version is v.r.m.f<.h> where v, r, m, f, and h are all numeric values identifying the version, release, modification, fix, and optional hot fix levels. The specified version must be 4.2.0.0 or newer, be installed on the resource where the management API service is running and it must be within the same base installation path as the version used to start the domain; otherwise, the instance fails to start.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalArgumentException - if an operation listener does not exist for the specified listenerId or if the format of the version is not correct.
        java.lang.IllegalStateException - if the instance is already started or if the operation is unable to complete successfully.
        java.lang.NullPointerException - if version is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.2.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
        See Also:
        start(String)
      • stop

        void stop(boolean force,
                  java.lang.String listenerId)
        Stops the instance.
        Parameters:
        force - - Indicates whether the instance is forced to stop when the authentication service is not available.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalArgumentException - if an operation listener does not exist for the specified listenerId.
        java.lang.IllegalStateException - if the instance is not started or if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • submitJob

        java.math.BigInteger submitJob(java.lang.String applicationId)
        Submits an application to run as a job in the instance. No submission parameters or configuration settings are set for the job. Resource load protection is not overridden. The default job group is used for controlling permission to the job and the default job name is assigned to the job.
        Parameters:
        applicationId - Identifies the deployed application to run. See deployApplication for information on deploying applications.
        Returns:
        the unique job identifier within the instance for the submitted job.
        Throws:
        java.lang.IllegalArgumentException - if a deployed application bundle does not exist for the specified applicationId
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if applicationId is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • submitJob

        java.math.BigInteger submitJob(java.lang.String applicationId,
                                       java.util.Map<java.lang.String,java.lang.String> submitParameters)
        Submits an application to run as a job in the instance with the specified submission parameter values. Resource load protection is not overridden. The default job group is used for controlling permission to the job and the default job name is assigned to the job.
        Parameters:
        applicationId - Identifies the deployed application to run. See deployApplication for information on deploying applications.
        submitParameters - contains the parameter names and corresponding values to set when the job is submitted or null if no parameters are needed.
        Returns:
        the unique job identifier within the instance for the submitted job.
        Throws:
        java.lang.IllegalArgumentException - if a deployed application bundle does not exist for the specified applicationId
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if applicationId is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • submitJob

        java.math.BigInteger submitJob(java.lang.String applicationId,
                                       java.util.Map<java.lang.String,java.lang.String> submitParameters,
                                       java.util.Map<java.lang.String,java.lang.String> configurationSettings,
                                       boolean overrideResourceLoadProtection,
                                       java.lang.String jobGroup,
                                       java.lang.String jobName,
                                       java.lang.String listenerId)
        Submits an application to run as a job in the instance.
        Parameters:
        applicationId - Identifies the deployed application to run. See deployApplication for information on deploying applications.
        submitParameters - contains the parameter names and corresponding values to set when the job is submitted or null if no parameters are needed.
        configurationSettings - contains the configuration settings to be used for this submission or null if no settings are needed. The supported configuration settings are as follows:
        • data-directory specifies the location of the data directory. For example: /myDataDirectory.
        • dynamicThreadingElastic specifies whether PEs should dynamically adapt the number of threads used for dynamic threading within the PE. Valid values are true and false. If this setting is not specified, the value of DYNAMIC_THREADING_ELASTIC is used. See this property description for more details.
        • dynamicThreadingThreadCount specifies the initial number of threads for dynamic threading in a PE. The value must be greater than or equal to 1. If this setting is not specified, the value of DYNAMIC_THREADING_THREAD_COUNT is used. See this property description for more details.
        • fusionScheme specifies the scheme used to determine how to fuse an application's operators into PEs. See the FusionScheme enumeration for possible values. The toString() value of the enumeration value must be used as the setting value. If this setting is not specified and the fusionTargetPeCount setting is not specified, the value of PropertyId.FUSION_SCHEME is used.
        • fusionTargetPeCount specifies the target PE count when fusing operators. The actual PE count could be higher or lower than this value. It is an error if this setting is specified and another fusion setting is also specified.
        • placementScheme specifies the scheme used to determine how to place PEs on resources. See the PlacementScheme enumeration for possible values. The toString() value of the enumeration value must be used as the setting value. If this setting is not specified, the value of PLACEMENT_SCHEME is used.
        • preloadApplicationBundles specifies whether to preload the job onto all resources in the instance, even if it is not currently needed there. Valid values are true and false. Preloading the job can improve the performance if the PE is relocated to a new resource.
        • threadingModel specifies the model which determines how threads run operators in a PE. See the ThreadingModel enumeration for possible values. The toString() value of the enumeration value must be used as the setting value. If this setting is not specified, the value of THREADING_MODEL is used.
        • tracing specifies the trace setting for the PEs. Valid values are: error, warn, info, debug, and trace.
        overrideResourceLoadProtection - specifies whether to submit the job regardless of the load settings for the resource.
        jobGroup - identifies the job group to use in controlling permission to the submitted job. If a job group is not specified, the default job group is used.
        jobName - identifies a name to associate with the job. This name must be unique within the instance. If a name is not specified, a default name is generated.
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Returns:
        the unique job identifier within the instance for the submitted job.
        Throws:
        java.lang.IllegalArgumentException - if a deployed application bundle does not exist for the specified applicationId or if an operation listener does not exist for the specified listenerId.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.NullPointerException - if applicationId is null.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html
      • upgrade

        void upgrade(java.lang.String listenerId)
        Upgrades the running instance to the Streams version used to start the domain. The upgrade fails if the instance is not running, if the instance is already running the same Streams version as the domain, or if there are jobs running in the instance.
        Parameters:
        listenerId - identifies an operation listener created using createOperationListener. Status messages relating to the progress of this operation are added to the listener as the operation runs. Any existing messages contained in the listener are cleared before the operation starts. If the value is null, this parameter is ignored.
        Throws:
        java.lang.IllegalArgumentException - if an operation listener does not exist for the specified listenerId.
        java.lang.IllegalStateException - if the operation is unable to complete successfully.
        java.lang.SecurityException - if the current user does not have the required permissions to perform the operation. Information about Streams permissions can be found in the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.2.0/com.ibm.streams.cfg.doc/doc/ibminfospherestreams-security-objects-tables.html