Difference between revisions of "Plugins"

From GreenVulcano Wiki
Jump to: navigation, search
(Mail)
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
In {{GVESB}}, a plug-in (or plugin) is a software component that extends the capability to access an external system, database or data in general.  
+
In {{GVESB}}, a plug-in is a software component that extends the capability to access an external system, database or data in general.  
  
 
For example, plug-ins are commonly used in {{GVESB}} to read Excel files ([[excelreader-call]]), or for reading/writing a file ([[filereader-call]] / [[filewriter-call]]).
 
For example, plug-ins are commonly used in {{GVESB}} to read Excel files ([[excelreader-call]]), or for reading/writing a file ([[filereader-call]] / [[filewriter-call]]).
 
  
 
The following tables show all the available {{GVESB}} plugins grouped by technology:
 
The following tables show all the available {{GVESB}} plugins grouped by technology:
  
 
+
==File system==
'''File management'''
 
  
 
{|class="gvtable" style="width: 80%"
 
{|class="gvtable" style="width: 80%"
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
|-
 
|-
| [[File:GVFileReader.png |20px]] || [[filereader-call]] || reading from a file present in the file system
+
| [[File:GVFileReader.png |20px]] || [[filereader-call]] || reading a file present in the local file system
 +
|-
 +
| [[File:GVFileWriter.png |20px]] || [[filewriter-call]] || writing a file in the local file system
 
|-
 
|-
| [[File:GVFileWriter.png |20px]] || [[filewriter-call]] || writing into a file present in the file system or creating one
+
| [[File:GVFileManager.png |20px]] || [[filemanager-call]] || searching, moving, coping, deleting, compressing and uncompressing files/directories
 
|-
 
|-
| [[File:GVFileManager.png |20px]] || [[filemanager-call]] || searching, moving, coping, deleting, compressing and uncompressing a file  
+
| [[File:GVFsMonitor2.png |20px]] || [[fsmonitor-call]] || getting a XML report of a directory containing the existing, created, modified and deleted files, from the last scan, on local or remote file system
 
|-
 
|-
| [[File:GVFsMonitor2.png |20px]] || [[fsmonitor-call]] || getting a XML report of a directory containing the existing, created, modified and deleted files  from the last scanning
+
| [[File:GVRemoteManager.png |20px]] || [[remotemanager-call]] || performing operations on files/directories present in a remote file system via FTP/SFTP/FTPS
 
|-
 
|-
| [[File:GVRemoteManager.png |20px]] || [[remotemanager-call]] || performing operations to a file present in the file system via FTP/SFTP/FTPS
+
| [[File:GVShellID.png |20px]] || [[shell-call]] || executing a local shell command
 
|-
 
|-
| [[File:GVShellID.png |20px]] || [[shell-call]] || executing a command shell
+
| [[File:GVRSHFileReader.png |20px]] || [[rsh-filereader-call]] || reading a file in a local or remote file system through the {{GVESB}} RSH RMI server
 +
|-
 +
| [[File:GVRSHFileWriter.png |20px]] || [[rsh-filewriter-call]] || writing a file in a local or remote file system through the {{GVESB}} RSH RMI server
 +
|-
 +
| [[File:GVRSHCall.png |20px]] || [[rsh-call]] || executing a shell command in a local or remote system through the {{GVESB}} RSH RMI server
 
|}
 
|}
  
'''WebService'''
+
==WebService==
  
 
{|class="gvtable" style="width: 80%"
 
{|class="gvtable" style="width: 80%"
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
|-
 
|-
| [[File:GVWsCall.png | 20px]] || [[ws-call]] || defining useful information for making a call to a Web Service
+
| [[File:GVWsCall.png | 20px]] || [[ws-call]] || invoking a Web Service using SOAP
 +
|}
 +
<div class="version_ge3.4">
 +
{|class="gvtable" style="width: 80%"
 +
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 +
|-
 +
| [[File:GVWsCall.png | 20px]] || [[rest-call]] || invoking a Web Service using REST
 
|}
 
|}
 +
</div>
  
'''Query DB'''
+
==Data Base==
  
 
{|class="gvtable" style="width: 80%"
 
{|class="gvtable" style="width: 80%"
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
|-
 
|-
| [[File:GVDBCall.png | 20px]] || [[Gvvcl-db|db-call]] || querying a DB
+
| [[File:GVDBCall.png | 20px]] || [[db-call]] || basic DB interaction
 +
|-
 +
| [[File:GVDHCall.png | 20px]] || [[dh-call]] || defining the parameter for making a call to [[DataHandler]]
 
|-
 
|-
| [[File:GVDHCall.png | 20px]] || [[Gvvcl-datahandler|dh-call]] || defining the parameter for making a call to Data Handler
+
| [[File:GVBirtReportCall.png | 20px]] || [[birt-report-call]] || generate a BIRT report
 
|-
 
|-
| [[File:GVBirtReportCall.png | 20px]] || [[birt-report-call]] || defining the parameter to generate a BIRT report
+
| [[File:GVExcelCall.png | 20px]] || [[excel-call]] || create an Excel report from a DB select
 
|-
 
|-
| [[File:GVExcelCall.png | 20px]] || [[excel-call]] || defining the parameter to create an Excel report from a DB select
+
| [[File:GVAdamCall.png | 20px]] || [[adamsearch-call]] || query ADAM document store using various filters
 
|}
 
|}
  
'''JMS queue'''
+
==JMS==
  
 
{|class="gvtable" style="width: 80%"
 
{|class="gvtable" style="width: 80%"
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
|-
 
|-
| [[File:Enqueue32.png | 20px]] || [[jms-enqueue]] || performing a queuing/publish operation on a queue/topic JMS
+
| [[File:Enqueue32.png | 20px]] || [[jms-enqueue]] || performing a queuing/publish operation on a JMS Queue/Topic
 
|-
 
|-
| [[File:Dequeue32.png | 20px]] || [[jms-dequeue]] || performing a reception operation from a queue/topic JMS
+
| [[File:Dequeue32.png | 20px]] || [[jms-dequeue]] || performing a reception operation from a JMS Queue/Topic
 
|}
 
|}
  
'''Routes'''
+
==Routing==
  
 
{|class="gvtable" style="width: 80%"
 
{|class="gvtable" style="width: 80%"
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
|-
 
|-
| [[File:GVRoutedDequeueCall.png | 20px]] || [[routed-dequeue]] || creating a routing mechanism at the level of communication channel<br/> During the execution of flows, the operation is seen as a simple dequeue
+
| [[File:GVRoutedCall.png | 20px]] || [[routed-call]] || creating a routing mechanism at the level of communication channel<br/> during the execution of flows, the operation is seen as a simple call
 
|-
 
|-
| [[File:GVRoutedEnqueueCall.png | 20px]] || [[routed-enqueue]] || creating a routing mechanism at the level of communication channel<br/> During the execution of flows, the operation is seen as a simple enqueue
+
| [[File:GVRoutedDequeueCall.png | 20px]] || [[routed-dequeue]] || creating a routing mechanism at the level of communication channel<br/> during the execution of flows, the operation is seen as a simple dequeue
 +
|-
 +
| [[File:GVRoutedEnqueueCall.png | 20px]] || [[routed-enqueue]] || creating a routing mechanism at the level of communication channel<br/> during the execution of flows, the operation is seen as a simple enqueue
 
|}
 
|}
  
'''Mail'''
+
==Mail==
  
 
{|class="gvtable" style="width: 80%"
 
{|class="gvtable" style="width: 80%"
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
|-
 
|-
| [[File:GVSmtpCall.png | 20px]] || [[smtp-call]] || sending an email
+
| [[File:GVSmtpCall.png | 20px]] || [[smtp-call]] || sending an email using SMTP protocol
 
|-
 
|-
| [[File:GVPopCall.png | 20px]] || [[pop-call]] || receiving an email
+
| [[File:GVPopCall.png | 20px]] || [[pop-call]] || receiving an email using POP3 protocol
 
|}
 
|}
 +
<div class="version_ge3.4">
 +
{|class="gvtable" style="width: 80%"
 +
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 +
|-
 +
| [[File:GVPopCall.png | 20px]] || [[pop-uid-remove-call]] || removing emails UID from UID cache, useful for email reprocess using POP3 protocol
 +
|-
 +
| [[File:GVSmtpCall.png | 20px]] || [[exchange-send-call]] || sending an email using Exchange WS interface
 +
|-
 +
| [[File:GVPopCall.png | 20px]] || [[exchange-receive-call]] || receiving an email using Exchange WS interface
 +
|-
 +
| [[File:GVPopCall.png | 20px]] || [[exchange-manage-call]] || manage an email on server using Exchange WS interface
 +
|}
 +
</div>
 +
<div class="version_ge3.4.0.10">
 +
{|class="gvtable" style="width: 80%"
 +
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 +
|-
 +
| [[File:GVPopCall.png | 20px]] || [[imap-call]] || receiving an email using IMAP protocol
 +
|-
 +
| [[File:GVPopCall.png | 20px]] || [[imap-manage-call]] || manage an email on server using IMAP protocol
 +
|-
 +
|}
 +
</div>
  
'''j2ee-calls'''
+
==J2EE==
  
 
{|class="gvtable" style="width: 80%"
 
{|class="gvtable" style="width: 80%"
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
|-
 
|-
| [[File:GVEjbCall.png | 20px]] || [[j2ee-ejb-call]] || invoking an Enterprise Java Bean
+
| [[File:GVEjbCall.png | 20px]] || [[j2ee-ejb-call]] || invoking an EJB (Enterprise Java Bean)
 
|-
 
|-
 
| [[File:GVJcaCall.png | 20px]] || [[j2ee-jca-call]] || invoking an adapter JCA  (Java Connector Architecture) that exposes the interface CCI  (Common Client Interface).
 
| [[File:GVJcaCall.png | 20px]] || [[j2ee-jca-call]] || invoking an adapter JCA  (Java Connector Architecture) that exposes the interface CCI  (Common Client Interface).
 
|}
 
|}
  
'''mm7-calls'''
+
==LDAP==
  
 
{|class="gvtable" style="width: 80%"
 
{|class="gvtable" style="width: 80%"
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
|-
 
|-
| [[File:Call.png | 20px]] || [[mm7-decode-call]] || decoding a MM7 multipart message (new)
+
| [[File:GVLDAPSearch.png | 20px]] || [[ldap-search-call]] || searching data on LDAP servers
 
|-
 
|-
| [[File:Call.png | 20px]] || [[mm7-submit-call]] || submitting a MM7 multipart message to a MMS-C server (new)
+
| [[File:GVLDAPUpdate.png | 20px]] || [[ldap-update-call]] || updating data on LDAP servers
 
|}
 
|}
  
'''util-calls'''
+
==Communication==
  
 
{|class="gvtable" style="width: 80%"
 
{|class="gvtable" style="width: 80%"
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
|-
 
|-
| [[File:Call.png | 20px]] || [[jmx-call]]  || invoking MBean methods or set/get attributes on local servers
+
| [[File:GVHttpCall.png | 20px]] || [[http-call]] || calling HTTP methods on remote servers
 +
|-
 +
| [[File:GVHl7Call.png | 20px]] || [[hl7-call]] || invoking synchronous services on systems that use the HL7 v2 protocol with messages either standard or in XML format
 +
|-
 +
| [[File:call.png | 20px]] || [[jbpm-call]] || using the JBPM plugin
 +
|-
 +
| [[File:call.png | 20px]] || [[jbpm-task-call]] || using the JBPM TASK plugin
 +
|-
 +
| [[File:GVopenspcoopCall.png | 20px]] || [[openspcoop-call]] || using the Open SPCoop plugin
 +
|}
 +
 
 +
==Utility==
 +
 
 +
{|class="gvtable" style="width: 80%"
 +
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 +
|-
 +
| [[File:GVJmxCall.png | 20px]] || [[jmx-call]]  || invoking MBean methods or set/get attributes on servers
 
|-
 
|-
 
| [[File:GVextractData.png | 20px]] || [[extract-data-call]] || extract data from the body of the message
 
| [[File:GVextractData.png | 20px]] || [[extract-data-call]] || extract data from the body of the message
 
|-
 
|-
| [[File:GVRoutedCall.png | 20px]] || [[routed-call]] || creating a routing mechanism at the level of communication channel<br/> During the execution of flows, the operation is seen as a simple call
+
| [[File:GVtest.png | 20px]] || [[test-service-call]] || simulate a test service
 
|-
 
|-
| [[File:GVtest.png | 20px]] || [[test-service-call]] || testing a service
+
| [[File:GVExcelReaderCall.png | 20px]] || [[excelreader-call]] || reading from a Excel file
 
|-
 
|-
| [[File:GVExcelReaderCall.png | 20px]] || [[excelreader-call]] || reading from a file Excel
+
| [[File:GVGenericCall.png | 20px]] || [[generic-call]] || doing a [[Develop Generic VCL Call|user developed generic plug-in]] invocation
|-
+
|-  
| [[File:call.png | 20px]] || [[generic-call]] || doing a generic invocation, for example to external systems
+
| [[File:GVCoreCall.png | 20px]] || [[gvcore-call]] || invoking directly a flow of the {{GVESB}} core. '''REMOVED in v3.2.0'''
 +
|-
 +
| [[File:GVRulesCall.png | 20px]] || [[rules-call]] || invoking a Rule Engine service
 +
|}
 +
<div class="version_ge3.5">
 +
{|class="gvtable" style="width: 80%"
 +
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
|-  
 
|-  
| [[File:call.png | 20px]] || [[gvcore-call]] || invoking directly a flow of the {{GVESB}} core
+
| [[File:GVPdfReaderCall.png | 20px]] || [[pdfreader-call]] || convert a Pdf file in a XML document
 
|}
 
|}
 +
</div>
 +
  
'''comm-calls'''
+
==Twitter==
  
 
{|class="gvtable" style="width: 80%"
 
{|class="gvtable" style="width: 80%"
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
|-
 
|-
| [[File:call.png | 20px]] || [[http-call]] || calling HTTP methods on remote servers
+
| [[File:Tweet.png | 20px]] || [[twitter-update-status]] || tweet
 
|-
 
|-
| [[File:call.png | 20px]] || [[hl7-call]] || invoking synchronous services on systems that use the HL7 v2 protocol with messages either standard or in XML format
+
| [[File:Retweet.png | 20px]] || [[twitter-retweet-status]] || retweet
 
|-
 
|-
| [[File:call.png | 20px]] || [[jbpm-call]] || using the JBPM plugin
+
| [[File:Follow.png | 20px]] || [[twitter-enable-notification]] || follow
 +
|-
 +
| [[File:Unfollow.png | 20px]] || [[twitter-disable-notification]] || unfollow
 +
|-
 +
| [[File:Follower.png | 20px]] || [[twitter-get-followers-ids]] || get followers
 +
|-
 +
| [[File:AddUser.png | 20px]] || [[twitter-get-friends-ids]] || get friends
 +
|-
 +
| [[File:Message.png | 20px]] || [[twitter-send-direct-message]] || send direct tweet
 +
|}
 +
<div class="version_ge3.3.4,3.4">
 +
{|class="gvtable" style="width: 80%"
 +
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...
 
|-
 
|-
| [[File:call.png | 20px]] || [[jbpm-task-call]] || using the JBPM TASK plugin
+
| [[File:Tweet.png | 20px]] || [[twitter-get-user-timeline]] || get user timeline
 
|-
 
|-
| [[File:call.png | 20px]] || [[openspcoop-call]] || using the OPENSPCOOP plugin
+
| [[File:Tweet.png | 20px]] || [[twitter-search]] || search status updates
 
|}
 
|}
 
+
</div>
 
{{VOTE}}
 
{{VOTE}}

Latest revision as of 07:34, 29 February 2016

In GreenVulcano® ESB, a plug-in is a software component that extends the capability to access an external system, database or data in general.

For example, plug-ins are commonly used in GreenVulcano® ESB to read Excel files (excelreader-call), or for reading/writing a file (filereader-call / filewriter-call).

The following tables show all the available GreenVulcano® ESB plugins grouped by technology:

File system

Plug-in Use this for ...
GVFileReader.png filereader-call reading a file present in the local file system
GVFileWriter.png filewriter-call writing a file in the local file system
GVFileManager.png filemanager-call searching, moving, coping, deleting, compressing and uncompressing files/directories
GVFsMonitor2.png fsmonitor-call getting a XML report of a directory containing the existing, created, modified and deleted files, from the last scan, on local or remote file system
GVRemoteManager.png remotemanager-call performing operations on files/directories present in a remote file system via FTP/SFTP/FTPS
GVShellID.png shell-call executing a local shell command
GVRSHFileReader.png rsh-filereader-call reading a file in a local or remote file system through the GreenVulcano® ESB RSH RMI server
GVRSHFileWriter.png rsh-filewriter-call writing a file in a local or remote file system through the GreenVulcano® ESB RSH RMI server
GVRSHCall.png rsh-call executing a shell command in a local or remote system through the GreenVulcano® ESB RSH RMI server

WebService

Plug-in Use this for ...
GVWsCall.png ws-call invoking a Web Service using SOAP
Plug-in Use this for ...
GVWsCall.png rest-call invoking a Web Service using REST

Data Base

Plug-in Use this for ...
GVDBCall.png db-call basic DB interaction
GVDHCall.png dh-call defining the parameter for making a call to DataHandler
GVBirtReportCall.png birt-report-call generate a BIRT report
GVExcelCall.png excel-call create an Excel report from a DB select
20px adamsearch-call query ADAM document store using various filters

JMS

Plug-in Use this for ...
Enqueue32.png jms-enqueue performing a queuing/publish operation on a JMS Queue/Topic
Dequeue32.png jms-dequeue performing a reception operation from a JMS Queue/Topic

Routing

Plug-in Use this for ...
GVRoutedCall.png routed-call creating a routing mechanism at the level of communication channel
during the execution of flows, the operation is seen as a simple call
GVRoutedDequeueCall.png routed-dequeue creating a routing mechanism at the level of communication channel
during the execution of flows, the operation is seen as a simple dequeue
GVRoutedEnqueueCall.png routed-enqueue creating a routing mechanism at the level of communication channel
during the execution of flows, the operation is seen as a simple enqueue

Mail

Plug-in Use this for ...
GVSmtpCall.png smtp-call sending an email using SMTP protocol
GVPopCall.png pop-call receiving an email using POP3 protocol
Plug-in Use this for ...
GVPopCall.png pop-uid-remove-call removing emails UID from UID cache, useful for email reprocess using POP3 protocol
GVSmtpCall.png exchange-send-call sending an email using Exchange WS interface
GVPopCall.png exchange-receive-call receiving an email using Exchange WS interface
GVPopCall.png exchange-manage-call manage an email on server using Exchange WS interface
Plug-in Use this for ...
GVPopCall.png imap-call receiving an email using IMAP protocol
GVPopCall.png imap-manage-call manage an email on server using IMAP protocol

J2EE

Plug-in Use this for ...
GVEjbCall.png j2ee-ejb-call invoking an EJB (Enterprise Java Bean)
GVJcaCall.png j2ee-jca-call invoking an adapter JCA (Java Connector Architecture) that exposes the interface CCI (Common Client Interface).

LDAP

Plug-in Use this for ...
GVLDAPSearch.png ldap-search-call searching data on LDAP servers
GVLDAPUpdate.png ldap-update-call updating data on LDAP servers

Communication

Plug-in Use this for ...
GVHttpCall.png http-call calling HTTP methods on remote servers
GVHl7Call.png hl7-call invoking synchronous services on systems that use the HL7 v2 protocol with messages either standard or in XML format
Call.png jbpm-call using the JBPM plugin
Call.png jbpm-task-call using the JBPM TASK plugin
GVopenspcoopCall.png openspcoop-call using the Open SPCoop plugin

Utility

Plug-in Use this for ...
GVJmxCall.png jmx-call invoking MBean methods or set/get attributes on servers
GVextractData.png extract-data-call extract data from the body of the message
GVtest.png test-service-call simulate a test service
GVExcelReaderCall.png excelreader-call reading from a Excel file
GVGenericCall.png generic-call doing a user developed generic plug-in invocation
GVCoreCall.png gvcore-call invoking directly a flow of the GreenVulcano® ESB core. REMOVED in v3.2.0
GVRulesCall.png rules-call invoking a Rule Engine service
Plug-in Use this for ...
GVPdfReaderCall.png pdfreader-call convert a Pdf file in a XML document


Twitter

Plug-in Use this for ...
Tweet.png twitter-update-status tweet
Retweet.png twitter-retweet-status retweet
Follow.png twitter-enable-notification follow
Unfollow.png twitter-disable-notification unfollow
Follower.png twitter-get-followers-ids get followers
AddUser.png twitter-get-friends-ids get friends
Message.png twitter-send-direct-message send direct tweet
Plug-in Use this for ...
Tweet.png twitter-get-user-timeline get user timeline
Tweet.png twitter-search search status updates

{{#w4grb_rate:}} <w4grb_ratinglist latestvotes items="5" nosort/>