Package com.uc4.communication.requests

Class AgentList.Filter

  • Enclosing class:
    AgentList
    public static class AgentList.Filter
extends java.lang.Object
    Filter in the Agent list.

    • Constructor Detail

      • Filter

        public Filter()

    • Method Detail

      • setConnectedFilter

        public void setConnectedFilter​(java.lang.Boolean connected)
        Sets a filter for the connection status.
        Parameters:
        connected - true if running agents should be returned, false for Agents that are not connected or null to disable this filter.

      • getNameFilter

        public java.lang.String getNameFilter()
        Returns the name filter of the Agent.
        Returns:
        Name filter or null if disabled

      • getAgentVersionFilter

        public java.lang.String getAgentVersionFilter()
        Returns the version filter.
        Returns:
        Version with wildcards or null if this filter is disabled

      • getHardwareFilter

        public java.lang.String getHardwareFilter()
        Returns the Hardware filter.
        Returns:
        Hardware filter with wildcards or null if this filter is disabled.

      • getSoftwareFilter

        public java.lang.String getSoftwareFilter()
        Returns the Software filter.
        Returns:
        Software filter with wildcards or null if this filter is disabled.

      • getSoftwareVersionFilter

        public java.lang.String getSoftwareVersionFilter()
        Returns the Software version filter.
        Returns:
        Software version with wildcards or null if this filter is disabled

      • getTcpIPAddressFilter

        public java.lang.String getTcpIPAddressFilter()
        Returns the TCP/IP address filter.
        Returns:
        Filter with wildcards or null if disabled

      • getLicenseClassFilter

        @Deprecated
public java.lang.String getLicenseClassFilter()
        Deprecated.
        the license check has been removed in version 12.2 and higher
        Returns the license class filter.
        Returns:
        Filter or null if disabled

      • getLicenseCategoryFilter

        @Deprecated
public java.lang.String getLicenseCategoryFilter()
        Deprecated.
        the license check has been removed in version 12.2 and higher
        Returns the license category filter.
        Returns:
        Filter with wildcards or null if disabled

      • getRolesFilter

        public java.lang.String getRolesFilter()
        Returns the roles filter.
        Returns:
        Roles filter with wildcards or null if this filter is disabled

      • getAuthenticatedFilter

        public java.lang.Boolean getAuthenticatedFilter()
        Returns the authentication filter of the Agent.
        Returns:
        true for authenticated Agents only, false for agents that are not authenticated or null if this filter is disabled.

      • getLinkedToServiceManagerFilter

        public java.lang.Boolean getLinkedToServiceManagerFilter()
        Returns the service manager link filter.
        Returns:
        true for Agents that are linked with the service manager, false for Agents that are not linked or null if there is no filter on the service manger link status.

      • getNetAreaFilter

        public java.lang.String getNetAreaFilter()
        Returns the Net area filter.
        Returns:
        Net area filter with wildcards or null if not set

      • getMibFilter

        public java.lang.String getMibFilter()
        Returns the MIB filter.
        Returns:
        filter for the MIB column of null if not set

      • getConnectedFilter

        public java.lang.Boolean getConnectedFilter()
        Returns the filter for the connection status.
        Returns:
        true if only connected agents should be returned, false for disconnected agents or null if there should be no filter on the connection status.

      • zduVersionFilter

        public java.lang.String zduVersionFilter()
        Returns the ZDU version filter.
        Returns:
        filter for the ZDU column of null if not set

      • setMaxRows

        public void setMaxRows​(int maxRows)
        Used to limit the number of returned agents. The value is ignored if it is larger than AGENT_LIST_LIMIT in UC_SYSTEM_SETTINGS.
        Parameters:
        maxRows - Maximum number of rows, value between 1 and AGENT_LIST_LIMIT.
        Throws:
        java.lang.IllegalArgumentException - if the value is negative or zero or larger than the allowed maximum AGENT_LIST_LIMIT: 20000

      • setNameFilter

        public void setNameFilter​(java.lang.String nameFilter)
        Sets the name filter of an Agent.
        Parameters:
        nameFilter - of the Agent with wildcards or null to disable this filter

      • setAgentVersionFilter

        public void setAgentVersionFilter​(java.lang.String agentVersionFilter)
        Sets a filter for the Agent version.
        Parameters:
        agentVersionFilter - Filter for the version of an Agent, null to disable this filter

      • setPlatformFilter

        public void setPlatformFilter​(java.lang.String platformFilter)
        Sets the platform filter.
        Parameters:
        platformFilter - Variant filter with wildcards, null if there should be no filter

      • getPlatformFilter

        public java.lang.String getPlatformFilter()
        Returns the platform filter.
        Returns:
        Variant filter with wildcards, null if there is no filter

      • setHardwareFilter

        public void setHardwareFilter​(java.lang.String hardwareFilter)
        Sets the hardware filter. It can contain wildcard characters.
        Parameters:
        hardwareFilter - Filter for the hardware info of the Agent, use null to disable this filter.

      • setSoftwareFilter

        public void setSoftwareFilter​(java.lang.String softwareFilter)
        Software filter.
        Parameters:
        softwareFilter - Filter for the software info of an Agent, use null to disable the filter.

      • setSoftwareVersionFilter

        public void setSoftwareVersionFilter​(java.lang.String softwareVersionFilter)
        Filter for software version.
        Parameters:
        softwareVersionFilter - software version of an Agent, return null to disable this filter.

      • setTcpIPAddressFilter

        public void setTcpIPAddressFilter​(java.lang.String tcpIPAddressFilter)
        Filter for IP addresses, wildcards * and ? can be used.
        Parameters:
        tcpIPAddressFilter - the network address filter of an Agent.

      • setLicenseClassFilter

        @Deprecated
public void setLicenseClassFilter​(java.lang.String filter)
        Deprecated.
        the license check has been removed in version 12.2 and higher
        Returns the license class filter.
        Parameters:
        filter - license class of an Agent, can be null to disable the filter.

      • setLicenseCategoryFilter

        @Deprecated
public void setLicenseCategoryFilter​(java.lang.String licenseCategoryFilter)
        Deprecated.
        the license check has been removed in version 12.2 and higher
        Returns the filter for license category. Wildcard characters ? and * can be used.
        Parameters:
        licenseCategoryFilter - License category of the Agent, can be null to disable the filter

      • setRolesFilter

        public void setRolesFilter​(java.lang.String roles)
        Returns the roles filter of the Agent. Wildcard characters ? and * can be used.
        Parameters:
        roles - Filter for roles, can be null to disable the filter.

      • setAuthenticatedFilter

        public void setAuthenticatedFilter​(java.lang.Boolean value)
        Sets the filter for the authentication of the Agent.
        Parameters:
        value - if the agent is authenticated, false if not. Use null to disable the filter.

      • setLinkedToServiceManagerFilter

        public void setLinkedToServiceManagerFilter​(java.lang.Boolean value)
        Sets the filter for the service manager link status.
        Parameters:
        value - true if the Agent is linked to Service Manager, false if not. Use null to disable this filter

      • setNetAreaFilter

        public void setNetAreaFilter​(java.lang.String netarea)
        Sets the NetArea filter in which this Agent runs.
        Parameters:
        netarea - can be null to disable this filter

      • setMibFilter

        public void setMibFilter​(java.lang.String mib)
        Parameters:
        mib - MIB filter or null to disable the filter

      • setzduVersionFilter

        public void setzduVersionFilter​(java.lang.String zdu)
        Parameters:
        zdu - ZDU version filter or null to disable the filter

      • getAgentTypesFilter

        public java.lang.String[] getAgentTypesFilter()
        Returns the agenttype filters.
        Returns:
        an array of agenttype filters or null if there is no filter.

      • setAgentTypesFilter

        public void setAgentTypesFilter​(java.lang.String... types)
        Sets the agenttypes filter.
        Parameters:
        types - the agenttypes or null

      • getRASolutionNameFilter

        public java.lang.String getRASolutionNameFilter()
        Returns the RA solution filter.
        Returns:
        the RA solution name or null if there is no filter.

      • setRASolutionNameFilter

        public void setRASolutionNameFilter​(java.lang.String raSolutionName)
        Sets the RA solution filter.
        Parameters:
        raSolutionName - the RA solution name or null

      • setTlsFilter

        public void setTlsFilter​(java.lang.Boolean isTls)
        Sets filter if this Agent is a TLS Agent
        Parameters:
        isTls - true for TLS Agent

      • getTlsFilter

        public java.lang.Boolean getTlsFilter()
        Returns the TLS Agent filter
        Returns:
        true if this is a TLS Agent

      • setGatewayFilter

        public void setGatewayFilter​(java.lang.String gateway)
        Sets filter for gateway filter
        Parameters:
        gateway - name of gateway

      • getGatewayFilter

        public java.lang.String getGatewayFilter()
        Returns the gateway filter
        Returns:
        name of gateway