Jump to: navigation, search

Difference between revisions of "ProxyManager"

(Created page with "The general management of proxies and all available operations for proxy objects are handled via the ProxyManager. The ProxyManager is an UBIK object provided by the Kernel. T...")
 
(→‎See also)
 
(9 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
The ProxyManager is an UBIK object provided by the Kernel. The UBIK environment object provides access to an instance of an ProxyManager.
 
The ProxyManager is an UBIK object provided by the Kernel. The UBIK environment object provides access to an instance of an ProxyManager.
  
−
{{Hint|The ProxyManager can be used in coding / customizinmg only.}}
+
'''Example: Asking the Environment for an ProxyManager instance'''
 +
 
 +
<source lang="csharp">
 +
// Asking the Environment for an ProxyManager instance.
 +
 
 +
using UBIK.Kernel;
 +
 
 +
UBIK.Interface.ProxyManager pxManager = anyUbikObject.Environment.GetProxyManager();
 +
 
 +
</source>
 +
 
 +
{{Hint|The ProxyManager can be used in coding / customizing only.}}
 
{{Attention|There is no UI support of the ProxyManager (yet).}}
 
{{Attention|There is no UI support of the ProxyManager (yet).}}
 +
 +
 +
'''Example: Maintaining the Import / Export Status of a Proxy object by using a ProxyManager'''
 +
 +
<source lang="csharp">
 +
// Maintaining the Import / Export Status of a Proxy object by using a ProxyManager.
 +
 +
using UBIK.Kernel;
 +
using System.Collections.Generic;
 +
 +
// first we have to have a proxy object
 +
UBIK.Interface.Proxy proxyInstance = GetProxyInstanceFromAnyWhere();                   
 +
 +
// fetching a ProxyManager instance
 +
UBIK.Interface.ProxyManager pxManager = anyUbikObject.Environment.GetProxyManager();
 +
 +
//Queing the proxyInstance for Import
 +
pxManager.QueueForImport(new List<Proxy>() { proxyInstance });
 +
 +
//Queing the proxyInstance for Export
 +
pxManager.QueueForExport(new List<Proxy>() { proxyInstance });
 +
 +
</source>
 +
 +
 +
'''Example: Import / Export a Proxy object by using a ProxyManager'''
 +
 +
<source lang="csharp">
 +
// Import / Export a Proxy object by using a ProxyManager.
 +
 +
using UBIK.Kernel;
 +
 +
// first we have to have a proxy object
 +
UBIK.Interface.Proxy proxyInstance = GetProxyInstanceFromAnyWhere();                   
 +
 +
// fetching a ProxyManager instance
 +
UBIK.Interface.ProxyManager pxManager = anyUbikObject.Environment.GetProxyManager();
 +
 +
//Import Proxy
 +
UBIK.Interface.ProxyUpdateInformation importResult = pxManager.UpdateProxyToUbik( proxyInstance );
 +
 +
//Export Proxy
 +
UBIK.Interface.ProxyExportInformation exportResult =pxManager.UpdateUbikToProxy( proxyInstance );
 +
 +
</source>
 +
 +
 +
'''ProxyUpdateErrorCode'''
 +
 +
The ProxyUpdateErrorCode property on the ProxyUpdateInformation and ProxyExportInformation  provides extended information in case of a not successfull update (export / import). This will help the admin to find inconsistencies in the data. (revision 4 and higher)
 +
 +
{| class="wikitable" | width = "50%"
 +
|-
 +
! Error Value!! ErrorName !! Description
 +
|-
 +
| 0|| NoError || Operation was successfull
 +
|-
 +
| 1|| UnknownProxyType || The Proxy or its MetaProxy is not configured correctly (e.g. not using the right Metaclass)
 +
|-
 +
| 2|| NotQueued || The Proxy was not in the correct status (workflow) for the operation
 +
|-
 +
| 3|| TargetInstanceCreationFailed || Creation of a new Targetinstance was not successfull
 +
|-
 +
| 4|| SyncProxyAndTargetDataFailed || An error occured during the update of the data on the target proxy (e.g. wrong data type, etc.)
 +
|-
 +
| 5|| SyncProxyAndTargetReferencesFailed || An error occured during the update of the references of the proxy
 +
|-
 +
| 6|| UnknownTargetType || The TargetType is not configured correctly (e.g. wront Target Meta Class)
 +
|-
 +
| 7|| NoTargetInstanceAvailable || The target object for an proxy is not available any more (only for export)
 +
|-
 +
|}
 +
 +
  
 
==See also==
 
==See also==
 
* [[MetaProxy]]
 
* [[MetaProxy]]
 
* [[ProxyMetaProperty]]
 
* [[ProxyMetaProperty]]
 +
* [[ProxyScanner]]
 +
* [[HowTo:Configure_Proxies]]
 +
* [[DocumentProxy]]
  
−
[[Category:Interfacing]]
+
[[Category:Interfacing|ProxyManager]]

Latest revision as of 14:56, 24 June 2024

The general management of proxies and all available operations for proxy objects are handled via the ProxyManager. The ProxyManager is an UBIK object provided by the Kernel. The UBIK environment object provides access to an instance of an ProxyManager.

Example: Asking the Environment for an ProxyManager instance

// Asking the Environment for an ProxyManager instance.

using UBIK.Kernel;

UBIK.Interface.ProxyManager pxManager = anyUbikObject.Environment.GetProxyManager();
IC Hint square.pngThe ProxyManager can be used in coding / customizing only.
IC Attention.pngThere is no UI support of the ProxyManager (yet).


Example: Maintaining the Import / Export Status of a Proxy object by using a ProxyManager

// Maintaining the Import / Export Status of a Proxy object by using a ProxyManager.

using UBIK.Kernel;
using System.Collections.Generic;

// first we have to have a proxy object
UBIK.Interface.Proxy proxyInstance = GetProxyInstanceFromAnyWhere();                    

// fetching a ProxyManager instance
UBIK.Interface.ProxyManager pxManager = anyUbikObject.Environment.GetProxyManager();

//Queing the proxyInstance for Import
pxManager.QueueForImport(new List<Proxy>() { proxyInstance });

//Queing the proxyInstance for Export
pxManager.QueueForExport(new List<Proxy>() { proxyInstance });


Example: Import / Export a Proxy object by using a ProxyManager

// Import / Export a Proxy object by using a ProxyManager.

using UBIK.Kernel;

// first we have to have a proxy object
UBIK.Interface.Proxy proxyInstance = GetProxyInstanceFromAnyWhere();                    

// fetching a ProxyManager instance
UBIK.Interface.ProxyManager pxManager = anyUbikObject.Environment.GetProxyManager();

//Import Proxy
UBIK.Interface.ProxyUpdateInformation importResult = pxManager.UpdateProxyToUbik( proxyInstance );

//Export Proxy
UBIK.Interface.ProxyExportInformation exportResult =pxManager.UpdateUbikToProxy( proxyInstance );


ProxyUpdateErrorCode

The ProxyUpdateErrorCode property on the ProxyUpdateInformation and ProxyExportInformation provides extended information in case of a not successfull update (export / import). This will help the admin to find inconsistencies in the data. (revision 4 and higher)

Error Value ErrorName Description
0 NoError Operation was successfull
1 UnknownProxyType The Proxy or its MetaProxy is not configured correctly (e.g. not using the right Metaclass)
2 NotQueued The Proxy was not in the correct status (workflow) for the operation
3 TargetInstanceCreationFailed Creation of a new Targetinstance was not successfull
4 SyncProxyAndTargetDataFailed An error occured during the update of the data on the target proxy (e.g. wrong data type, etc.)
5 SyncProxyAndTargetReferencesFailed An error occured during the update of the references of the proxy
6 UnknownTargetType The TargetType is not configured correctly (e.g. wront Target Meta Class)
7 NoTargetInstanceAvailable The target object for an proxy is not available any more (only for export)


See also

Retrieved from "https://wiki.augmensys.com/index.php?title=ProxyManager&oldid=26877"