JCOBridge

java.lang.Object
- org.mases.jcobridge.JCHandler
- - org.mases.jcobridge.JCOBridge

```
public final class JCOBridge
extends JCHandler
```
The JCOBridge class represents the main entry point to interact with CLR context.
Some examples on its use are on https://github.com/masesgroup/JCOReflector

Since:

1.0.0.0

Author:

MASES S.R.L.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`AddPath(String path)` Adds a path where the wrapper searches for CLR assemblies
`JCAssembly`	`AddReference(String assemblyName)` Adds a reference to a CLR assembly
`static IJCGraphicContainer`	`CreateContainer(Component comp)` Returns a reference to a newly created `IJCGraphicContainer` instance
`static IJCGraphicContainer`	`CreateContainer(String className)` Returns a reference to a newly created `IJCGraphicContainer` instance
`static JCOBridge`	`CreateNew()` Create a new instance of `JCOBridge` .
`static Object`	`GetCLRGlobal(String key)` Get previously registered CLR global `Object`.
`static String`	`getCLRRID()` This method is used to get the Rid to use.
`JCControl`	`GetControl(String type)` Returns an instance of `JCControl` which reference a graphical CLR Object
`static Boolean`	`getCoreCLREnableDesktop()` This method is used to get if Desktop features are requested.
`static String`	`getCoreCLRVersion()` This method is used to get the framework to be used: valid values are 8 (Default) and 9.
`JCEnum`	`GetEnum(String type)` Returns a reference to a CLR Enum
`static String[]`	`getFilteredArgs()` This method is used to get the arguments from command-line filtered from the arguments related to JCOBridge
`static boolean`	`getGlobalize()` This method is used to get the Globalize value.
`JCJControl`	`GetJControl(String type)` Returns an instance of `JCJControl` which reference a graphical CLR Object
`static Object`	`GetJVMGlobal(String key)` Get previously registered JVM global `Object`.
`static String`	`getLicensePath()` This method is used to get the path where is located the JCOBridge license.
`static String`	`getNativePath()` This method is used to get the path where to load JCOBridge runtime library.
`static String`	`getScopeOn()` This method is used to get the ScopeOn value.
`static String`	`getScopeOnVersion()` This method is used to get the ScopeOn Version value.
`JCType`	`GetType(String type)` Returns a reference to a CLR Type
`static void`	`Initialize()` Initialize the library for .NET with default parameters.
`static void`	`Initialize(String[] args)` Initialize the library for .NET.
`static void`	`InitializeFromRemote(String licencePath, boolean globalize)` Initialize the library from CLR.
`static boolean`	`isCLRHostingProcess()` This method is used to get information about the hosting process.
`static void`	`Load()` This method is used to loads the CLR/JVM Wrapper library.
`static void`	`LoadWrapper(String libraryName)` This method is used to loads the CLR/JVM Wrapper library.
`Object`	`NewObject(JCType type, Object... params)` Returns a reference to a newly created CLR Object
`Object`	`NewObject(String type, Object... params)` Returns a reference to a newly created CLR Object
`void`	`RegisterEventLog(IJCEventLog logger)` Register an instance of `IJCEventLog` for debug logging purpose.
`static void`	`RegisterJVMGlobal(String key, Object obj)` Register the object into the global JVM mapper.
`static void`	`setCLRRID(String rid)` This method is used to set the Rid to use.
`static void`	`setCoreCLREnableDesktop(Boolean value)` This method is used to set if Desktop features are requested.
`static void`	`setCoreCLRVersion(String clrApp)` This method is used to set the framework to be used: valid values are 8 (Default) and 9.
`static void`	`setGlobalize(boolean globalize)` This method is used to set the Globalize value.
`static void`	`setLicensePath(String path)` This method is used to set the path where is located the JCOBridge license.
`static void`	`setNativePath(String path)` This method is used to set the path where to load JCOBridge runtime library.
`static void`	`setScopeOn(String value)` This method is used to set the ScopeOn value.
`static void`	`setScopeOnVersion(String value)` This method is used to set the ScopeOn Version value.
`static void`	`SetWrapperPath(String path)` This method is used to set the path where is located the CLR/JVM Wrapper library.
`static void`	`UnregisterJVMGlobal(String key)` Unregister the object from the global JVM mapper.

Methods inherited from class org.mases.jcobridge.JCHandler
getReference

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getFilteredArgs
```
public static String[] getFilteredArgs()
```
    This method is used to get the arguments from command-line filtered from the arguments related to JCOBridge
    
    Returns:
    
    The filtered arguments.
  - getNativePath
```
public static String getNativePath()
```
    This method is used to get the path where to load JCOBridge runtime library.
    
    Returns:
    
    The path to use to load JCOBridge runtime.
  - setNativePath
```
public static void setNativePath(String path)
```
    This method is used to set the path where to load JCOBridge runtime library.
    
    Parameters:
    
    path - The path to use to load JCOBridge runtime.
  - getLicensePath
```
public static String getLicensePath()
```
    This method is used to get the path where is located the JCOBridge license.
    
    Returns:
    
    The path where is located the JCOBridge license.
  - setLicensePath
```
public static void setLicensePath(String path)
```
    This method is used to set the path where is located the JCOBridge license.
    
    Parameters:
    
    path - The path where is located the JCOBridge license.
  - getCLRRID
```
public static String getCLRRID()
```
    This method is used to get the Rid to use.
    
    Returns:
    
    The Rid to use. Searched autmatically, using some system infos. Set it to override searched value.
  - setCLRRID
```
public static void setCLRRID(String rid)
```
    This method is used to set the Rid to use.
    
    Parameters:
    
    rid - The Rid to use. Searched autmatically, using some system infos. Set it to override searched value.
  - getCoreCLRVersion
```
public static String getCoreCLRVersion()
```
    This method is used to get the framework to be used: valid values are 8 (Default) and 9.
    
    Returns:
    
    The framework to be used: valid values are 8 (Default) and 9.
  - setCoreCLRVersion
```
public static void setCoreCLRVersion(String clrApp)
```
    This method is used to set the framework to be used: valid values are 8 (Default) and 9.
    
    Parameters:
    
    clrApp - The framework to be used: valid values are 8 (Default) and 9.
  - getCoreCLREnableDesktop
```
public static Boolean getCoreCLREnableDesktop()
```
    This method is used to get if Desktop features are requested.
    
    Returns:
    
    true if Desktop features are requested.
  - setCoreCLREnableDesktop
```
public static void setCoreCLREnableDesktop(Boolean value)
```
    This method is used to set if Desktop features are requested.
    
    Parameters:
    
    value - true if Desktop features are requested.
  - getScopeOn
```
public static String getScopeOn()
```
    This method is used to get the ScopeOn value.
    
    Returns:
    
    the ScopeOn value.
  - setScopeOn
```
public static void setScopeOn(String value)
```
    This method is used to set the ScopeOn value.
    
    Parameters:
    
    value - the ScopeOn value.
  - getScopeOnVersion
```
public static String getScopeOnVersion()
```
    This method is used to get the ScopeOn Version value.
    
    Returns:
    
    the ScopeOn Version value.
  - setScopeOnVersion
```
public static void setScopeOnVersion(String value)
```
    This method is used to set the ScopeOn Version value.
    
    Parameters:
    
    value - the ScopeOn Version value.
  - getGlobalize
```
public static boolean getGlobalize()
```
    This method is used to get the Globalize value.
    
    Returns:
    
    the value of the globalize of the .NET core instance.
  - setGlobalize
```
public static void setGlobalize(boolean globalize)
```
    This method is used to set the Globalize value.
    
    Parameters:
    
    globalize - Set to false to do not globalize the .NET core instance.
  - isCLRHostingProcess
```
public static boolean isCLRHostingProcess()
```
    This method is used to get information about the hosting process.
    
    Returns:
    
    true if the hosting process is a CLR, false if the hosting process is a JVM.
  - SetWrapperPath
```
public static void SetWrapperPath(String path)
```
    This method is used to set the path where is located the CLR/JVM Wrapper library.
    Note: Do not use directly.
    
    Parameters:
    
    path - The path to use to search the CLR/JVM Wrapper library. It can be absolute or relative.
  - Load
```
public static void Load()
                 throws IOException
```
    This method is used to loads the CLR/JVM Wrapper library.
    Note: Do not use directly.
    
    Throws:
    
    IOException - in case of error
  - LoadWrapper
```
public static void LoadWrapper(String libraryName)
                        throws IOException
```
    This method is used to loads the CLR/JVM Wrapper library. *
    Note: Do not use directly.
    
    Parameters:
    
    libraryName - The name of the native wrapper library to load
    
    Throws:
    
    IOException - in case of error
  - Initialize
```
public static void Initialize()
                       throws JCNativeException,
                              JCException,
                              IOException
```
    Initialize the library for .NET with default parameters.
    Parameters can be set into the environment variable named JCOBRIDGE_JVM_SETTINGS within a string. Each parameter shall be separated by && in the following form: PARAM1&&PARAM2&&PARAM3
    
    Throws:
    
    JCNativeException - If something happens within CLR context
    
    JCException - Something happened at library level
    
    IOException - If something happens with filesystem
    
    Since:
    
    2.0.0.0
  - Initialize
```
public static void Initialize(String[] args)
                       throws IOException,
                              JCException
```
    Initialize the library for .NET.
    Parameters can be set into the environment variable named JCOBRIDGE_JVM_SETTINGS within a string. Each parameter shall be separated by && in the following form: PARAM1&&PARAM2&&PARAM3
    
    Parameters:
    
    args - Arguments from command line
    
    Throws:
    
    IOException - If something happens with filesystem
    
    JCException - Something happended during initialization
    
    Since:
    
    2.1.0.0
  - InitializeFromRemote
```
public static void InitializeFromRemote(String licencePath,
                                        boolean globalize)
                                 throws JCNativeException,
                                        IOException
```
    Initialize the library from CLR.
    Note: Do not use directly.
    
    Parameters:
    
    licencePath - The path to the license file
    
    globalize - The globalize value
    
    Throws:
    
    JCNativeException - if something happens within CLR context
    
    IOException - if something happens with filesystem
    
    Since:
    
    2.0.0.0
  - CreateNew
```
public static JCOBridge CreateNew()
                           throws JCNativeException
```
    Create a new instance of JCOBridge .
    
    Returns:
    
    A new instance of JCOBridge
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - RegisterJVMGlobal
```
public static void RegisterJVMGlobal(String key,
                                     Object obj)
                              throws JCNativeException
```
    Register the object into the global JVM mapper.
    
    Parameters:
    
    key - The key to identify the registered Object
    
    obj - The Object to register
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - UnregisterJVMGlobal
```
public static void UnregisterJVMGlobal(String key)
                                throws JCNativeException
```
    Unregister the object from the global JVM mapper.
    
    Parameters:
    
    key - The key to identify the registered Object
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - GetJVMGlobal
```
public static Object GetJVMGlobal(String key)
                           throws JCNativeException
```
    Get previously registered JVM global Object.
    
    Parameters:
    
    key - The key to use to get back the object from JVM global context
    
    Returns:
    
    Previously registered global Object
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - GetCLRGlobal
```
public static Object GetCLRGlobal(String key)
                           throws JCNativeException
```
    Get previously registered CLR global Object.
    
    Parameters:
    
    key - The key to use to get back the object from CLR global context
    
    Returns:
    
    Previously registered global Object
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - CreateContainer
```
public static IJCGraphicContainer CreateContainer(Component comp)
```
    Returns a reference to a newly created IJCGraphicContainer instance
    
    Parameters:
    
    comp - The Component to be integrated into UI
    
    Returns:
    
    An instance of the IJCGraphicContainer
  - CreateContainer
```
public static IJCGraphicContainer CreateContainer(String className)
                                           throws InstantiationException,
                                                  IllegalAccessException,
                                                  ClassNotFoundException,
                                                  JCException
```
    Returns a reference to a newly created IJCGraphicContainer instance
    
    Parameters:
    
    className - The class name of the object to be integrated into UI or a class implementing IJCGraphicContainer
    
    Returns:
    
    An instance of the IJCGraphicContainer
    
    Throws:
    
    IllegalAccessException - if the class or its nullary constructor is not accessible.
    
    InstantiationException - if this Class represents an abstract class, an interface, an array class, a primitive type, or void; or if the class has no nullary constructor; or if the instantiation fails for some other reason.
    
    ClassNotFoundException - if the class cannot be located
    
    JCException - if the the parameter is not valid to build an instance of IJCGraphicContainer
  - RegisterEventLog
```
public void RegisterEventLog(IJCEventLog logger)
                      throws JCNativeException
```
    Register an instance of IJCEventLog for debug logging purpose.
    
    Parameters:
    
    logger - The IJCEventLog instance
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - AddPath
```
public void AddPath(String path)
             throws JCNativeException
```
    Adds a path where the wrapper searches for CLR assemblies
    
    Parameters:
    
    path - The path to add
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - AddReference
```
public JCAssembly AddReference(String assemblyName)
                        throws JCNativeException
```
    Adds a reference to a CLR assembly
    
    Parameters:
    
    assemblyName - The assembly to reference
    
    Returns:
    
    A JCAssembly instance to the newly referenced CLR Assembly
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - GetType
```
public JCType GetType(String type)
               throws JCNativeException
```
    Returns a reference to a CLR Type
    
    Parameters:
    
    type - The type to search
    
    Returns:
    
    A JCType instance to the newly referenced CLR Type
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - GetEnum
```
public JCEnum GetEnum(String type)
               throws JCNativeException
```
    Returns a reference to a CLR Enum
    
    Parameters:
    
    type - The enum type to search
    
    Returns:
    
    A JCEnum instance to the newly referenced CLR Enum
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - GetControl
```
public JCControl GetControl(String type)
                     throws JCNativeException
```
    Returns an instance of JCControl which reference a graphical CLR Object
    
    Parameters:
    
    type - The graphical CLR Object to search
    
    Returns:
    
    A JCControl instance to the newly referenced graphical CLR Object
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - GetJControl
```
public JCJControl GetJControl(String type)
                       throws JCNativeException
```
    Returns an instance of JCJControl which reference a graphical CLR Object
    
    Parameters:
    
    type - The graphical CLR Object to search
    
    Returns:
    
    A JCJControl instance to the newly referenced graphical CLR Object
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - NewObject
```
public Object NewObject(String type,
                        Object... params)
                 throws JCNativeException
```
    Returns a reference to a newly created CLR Object
    
    Parameters:
    
    type - The type of the object to create
    
    params - Optional parameters to use in CLR object instantiation
    
    Returns:
    
    An instance of the CLR Object: it can be a primitive (bool, float, String) or JCObject for all other types
    
    Throws:
    
    JCNativeException - if something happens within CLR context
  - NewObject
```
public Object NewObject(JCType type,
                        Object... params)
                 throws JCNativeException
```
    Returns a reference to a newly created CLR Object
    
    Parameters:
    
    type - The JCType of the object to create
    
    params - Optional parameters to use in CLR object instantiation
    
    Returns:
    
    An instance of the CLR Object: it can be a primitive (bool, float, String) or JCObject for all other types
    
    Throws:
    
    JCNativeException - if something happens within CLR context

Class JCOBridge

Method Summary

Methods inherited from class org.mases.jcobridge.JCHandler

Methods inherited from class java.lang.Object

Method Detail

getFilteredArgs

getNativePath

setNativePath

getLicensePath

setLicensePath

getCLRRID

setCLRRID

getCoreCLRVersion

setCoreCLRVersion

getCoreCLREnableDesktop

setCoreCLREnableDesktop

getScopeOn

setScopeOn

getScopeOnVersion

setScopeOnVersion

getGlobalize

setGlobalize

isCLRHostingProcess

SetWrapperPath

Load

LoadWrapper

Initialize

Initialize

InitializeFromRemote

CreateNew

RegisterJVMGlobal

UnregisterJVMGlobal

GetJVMGlobal

GetCLRGlobal

CreateContainer

CreateContainer

RegisterEventLog

AddPath

AddReference

GetType

GetEnum

GetControl

GetJControl

NewObject

NewObject