Package org.eclipse.persistence.services.mbean

Interface MBeanDevelopmentServicesMBean

  • All Known Implementing Classes:
    MBeanDevelopmentServices
    public interface MBeanDevelopmentServicesMBean

    Purpose: Provide a dynamic interface into the EclipseLink Identity Map Manager.

    Description: This interface is meant to provide a framework for gaining access to configuration and statistics of the EclipseLink Cache during runtime. It provides JMX functionality

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getShouldBindAllParameters()
      Method returns if all Parameters should be bound or not
      int getStringBindingSize()
      Return the size of strings after which will be bound into the statement
      boolean getUsesBatchWriting()
      This method will return if batchWriting is in use or not.
      boolean getUsesByteArrayBinding()
      Shows if Byte Array Binding is turned on or not
      boolean getUsesJDBCBatchWriting()
      This method will return if batchWriting is in use or not.
      boolean getUsesNativeSQL()
      Shows if native SQL is being used
      boolean getUsesStreamsForBinding()
      This method indicates if streams are being used for binding
      boolean getUsesStringBinding()
      This method indicates if Strings are being bound
      void initializeAllIdentityMaps()
      This method is used to clear the contents of all identity maps.
      void initializeIdentityMap​(java.lang.String className)
      This method is used to clear the contents of a particular identity map.
      void refreshProject​(java.lang.String projectFilePath)
      This method used to reset a project in a session.
      void setIdentityMapForClass​(java.lang.String className, java.lang.String identityMapClassType, int maxSize)
      This method will be used to set a new type of identity map for a particular class type.
      void setShouldBindAllParameters​(boolean shouldBindAllParameters)
      This method is used to control if All parameters should be bound
      void setStringBindingSize​(int size)
      Sets the size of strings after which they will be bound into the statement
      void setUsesBatchWriting​(boolean usesBatchWriting)
      This method is used to turn on TopLink Batch Writing.
      void setUsesByteArrayBinding​(boolean usesByteArrayBinding)
      This method allows control of whether byte arrays should be bound into the statement or not.
      void setUsesJDBCBatchWriting​(boolean usesJDBCBatchWriting)
      This method is used to turn on JDBC Batch Writing.
      void setUsesNativeSQL​(boolean usesNativeSQL)
      This method allows the client to set if Native SQL should be used.
      void setUsesStreamsForBinding​(boolean usesStreamsForBinding)
      This method is used to set if streams should be used for binding.
      void setUsesStringBinding​(boolean usesStringBinding)
      Allows the client to set if String should be bound into the statement or not.
      void updateCacheSize​(java.lang.String className, int newSize)
      This method is used to update the cache size of a particular Identity Map If ClassNotFoundException is thrown then the IdenityMap for that class name could not be found

    • Method Detail

      • initializeIdentityMap

        void initializeIdentityMap​(java.lang.String className)
                    throws java.lang.ClassNotFoundException
        This method is used to clear the contents of a particular identity map. Users should be aware that if any of these objects are in use when this action is completed they will lose object identity. If ClassNotFoundException is thrown then the IdenityMap for that class name could not be found
        Throws:
        java.lang.ClassNotFoundException

      • initializeAllIdentityMaps

        void initializeAllIdentityMaps()
        This method is used to clear the contents of all identity maps. Users should be aware that if any of these objects are in use when this action is completed they will lose object identity.

      • setIdentityMapForClass

        void setIdentityMapForClass​(java.lang.String className,
                            java.lang.String identityMapClassType,
                            int maxSize)
                     throws java.lang.ClassNotFoundException
        This method will be used to set a new type of identity map for a particular class type. If objects of that class type are in use loss of object identity will result. For prevention client may wish to initialize all identity maps first. If ClassNotFoundException is thrown then the IdenityMap for that class name could not be found
        Throws:
        java.lang.ClassNotFoundException

      • refreshProject

        void refreshProject​(java.lang.String projectFilePath)
        This method used to reset a project in a session. All connected clients will get errors. project must be of the xml type. This attribute will not be stored on a save.

      • updateCacheSize

        void updateCacheSize​(java.lang.String className,
                     int newSize)
              throws java.lang.ClassNotFoundException
        This method is used to update the cache size of a particular Identity Map If ClassNotFoundException is thrown then the IdenityMap for that class name could not be found
        Throws:
        java.lang.ClassNotFoundException

      • setShouldBindAllParameters

        void setShouldBindAllParameters​(boolean shouldBindAllParameters)
        This method is used to control if All parameters should be bound

      • getShouldBindAllParameters

        boolean getShouldBindAllParameters()
        Method returns if all Parameters should be bound or not

      • setStringBindingSize

        void setStringBindingSize​(int size)
        Sets the size of strings after which they will be bound into the statement

      • getStringBindingSize

        int getStringBindingSize()
        Return the size of strings after which will be bound into the statement

      • setUsesBatchWriting

        void setUsesBatchWriting​(boolean usesBatchWriting)
        This method is used to turn on TopLink Batch Writing. Please note that toggling this setting while a transaction is open may result in mis-ordered sql statements or loss of statements. Also please note that TopLink Batch Writing may not work with all JDBC Drivers

      • getUsesBatchWriting

        boolean getUsesBatchWriting()
        This method will return if batchWriting is in use or not.

      • setUsesJDBCBatchWriting

        void setUsesJDBCBatchWriting​(boolean usesJDBCBatchWriting)
        This method is used to turn on JDBC Batch Writing. Please note that toggling this setting while a transaction is open may result in mis-ordered sql statements or loss of statements.

      • getUsesJDBCBatchWriting

        boolean getUsesJDBCBatchWriting()
        This method will return if batchWriting is in use or not.

      • setUsesByteArrayBinding

        void setUsesByteArrayBinding​(boolean usesByteArrayBinding)
        This method allows control of whether byte arrays should be bound into the statement or not. Toggling this attribute while an SQL statement is being built, or if you are caching statements, will result in errors.

      • getUsesByteArrayBinding

        boolean getUsesByteArrayBinding()
        Shows if Byte Array Binding is turned on or not

      • setUsesNativeSQL

        void setUsesNativeSQL​(boolean usesNativeSQL)
        This method allows the client to set if Native SQL should be used.

      • getUsesNativeSQL

        boolean getUsesNativeSQL()
        Shows if native SQL is being used

      • setUsesStreamsForBinding

        void setUsesStreamsForBinding​(boolean usesStreamsForBinding)
        This method is used to set if streams should be used for binding. Please note that toggling this attribute while a statement is being built will result in errors.

      • getUsesStreamsForBinding

        boolean getUsesStreamsForBinding()
        This method indicates if streams are being used for binding

      • setUsesStringBinding

        void setUsesStringBinding​(boolean usesStringBinding)
        Allows the client to set if String should be bound into the statement or not. Please note that toggling this attribute while a statement is being built, or if statement caching is being used, will result in errors.

      • getUsesStringBinding

        boolean getUsesStringBinding()
        This method indicates if Strings are being bound