Package net.officefloor.compile.mbean

Interface OfficeFloorMBean

  • public interface OfficeFloorMBean
    Proxy interface for the OfficeFloor MBean.
    Author:
    Daniel Sagenschneider

    • Method Detail

      • getOfficeNames

        java.lang.String[] getOfficeNames()
        Obtain the names of the Office instances within the OfficeFloor.
        Returns:
        Names of the Office instances within the OfficeFloor.

      • getManagedFunctionNames

        java.lang.String[] getManagedFunctionNames​(java.lang.String officeName)
        Obtains the names of the ManagedFunction instances within the Office.
        Parameters:
        officeName - Name of the Office.
        Returns:
        Names of the ManagedFunction instances within the Office.

      • getManagedFunctionParameterType

        java.lang.String getManagedFunctionParameterType​(java.lang.String officeName,
                                                 java.lang.String functionName)
        Obtains the parameter type for the ManagedFunction.
        Parameters:
        officeName - Name of the Office.
        functionName - Name of the ManagedFunction.
        Returns:
        Parameter type for the ManagedFunction. May be null if no parameter for ManagedFunction.

      • invokeFunction

        void invokeFunction​(java.lang.String officeName,
                    java.lang.String functionName,
                    java.lang.String parameter)
        Invokes the ManagedFunction.
        Parameters:
        officeName - Name of the Office.
        functionName - Name of the ManagedFunction within the Office.
        parameter - Optional parameter for the ManagedFunction. May be null.

      • closeOfficeFloor

        void closeOfficeFloor()
        Closes the OfficeFloor.