VSE Manager Plugin for IntelliJ IDEA

VSE Manager is a plug-in that works with integrated development environments (IDEs), such as Eclipse.
dts105
VSE Manager is an IntelliJ IDEA plug-in that you can use to create, deploy, and manage virtual services.
For more information about IntelliJ IDEA, see the JetBrains website.
In this article:
Install the VSE Manager Plugin for IntelliJ IDEA
The following procedures detail how to install the plugin on a Mac and on Windows.
(On Mac) Follow these steps:
  1. Download the VSE Manager plugin archive file (CASVpluginIDEA-1.0.0.zip) from one of the following links:
    Follow the standard IntelliJ IDEA procedure for adding new software.
  2. In the IntelliJ IDEA Editor, go to
    IntelliJ IDEA, Preferences, Plugins
    .
    The following image illustrates this step:
    Preferences
  3. On the
    Plugins
    page, click the cog icon, search for the VSE Manager plugin, select
    Install Plugin from Disk
    , select the
    VSE Manager
    plugin archive file, and then click
    OK
    .
    The following image illustrates this step:
    Plugins
  4. Click
    OK
    to apply the changes and restart IntelliJ IDEA (if prompted).
The VSE Manager plugin is installed.
(On Windows) Follow these steps:
  1. Download the VSE Manager plugin archive file (CASVpluginIDEA-1.0.0.zip) from one of the following links:
    Follow the standard IntelliJ IDEA procedure for adding new software.
  2. In the IntelliJ IDEA Editor, go to
    File, Settings
    .
    The following image illustrates this step:
    Settings
  3. Select
    Install Plugin from Disk
    .
    The following image shows this option:
    Plugins
The VSE Manager plugin is installed.
Configure the VSE Manager Plugin for IntelliJ IDEA
Follow these steps:
  1. In the IntelliJ IDEA Editor, in the
    Preferences
    panel, expand
    Tools
    , and then select
    VSE Manager
    .
    The Preference for the VSE manager view appears.
  2. Complete the following:
    1. In the
      Registry Web Server Connection Settings
      section, provide the following registry-specific details:
      Registry Web Server URL
      The URL for the VSE web server.
      User Name
      The user name that you use to log in to VSE Manager.
      Password
      The password that you use to log in to VSE Manager.
      To test the connection to make sure that the registry is up before applying the settings, click
      Test Settings
      .
    2. If the registry is configured with a secure connection such as HTTPS, then on the
      Registry SSL
      tab,
      Keystore Details
      section, enter valid keystores with certificates into the following fields:
      The following image shows this section:
      KeystoreDetails
      Keystore File
      The keystore that DevTest includes in the installation folder. The file path to the virtual service-specific Secure Sockets Layer (SSL) is dependent on the machine on which it is deployed. You can deploy virtual services on a machine other than the developer console that is running the VSE Manager plugin. The path to the keystore can be of Windows platform. This file can define the virtual service as being deployed on VSE Manager on Windows. You can also use the VSE Manager plugin on Macintosh/Ubuntu.
      The keystore’s path should be the path for the operating system hosting the virtual service environment (VSE).
      Example:
      webserver.ks
      Keystore Password
      The password for the key.
      Key Alias
      The alias for the key.
      Example:
      jetty
      Key Password
      The password for the key.
      You can also configure the SSL certificates for the registry or virtual service using a custom keystore.
    3. If you want to ensure that the VSE Manager view displays the latest summary of virtual services, configure the plugin to periodically update this list by completing the following:
      1. Click the
        Virtual Service SSL
        tab.
      2. In the
        View Settings
        section, select the
        Update the current status of all virtual services periodically
        option.
    4. For all interactions with VSE Manager, there are multiple REST calls to DevTest backend servers. If you need to monitor or view the RR pair, in
      Logging Settings
      , select the
      Logging request and response to console
      option.
  3. Click
    OK
    .
The VSE Manager plugin is configured.
Import a LISA Projects as Modules into IntelliJ IDEA Projects
Valid LISA projects are created in DevTest workstation and contain a lisa.project file. The following image shows a valid LISA project:
The following image shows a valid LISA project:
LisaProjExample
Projects contain artifacts such as Request-Response (RR) pairs (file), Swagger files, and Model Archive (MAR) files. You can remove imported modules at any time.
For more information about how to create and manage modules in IntelliJ IDEA, see the JetBrains website.
Follow these steps:
  1. In IntelliJ IDEA, click
    File, New, Module from Existing Sources
    .
    The following image illustrates this step:
    LisaProjExample
    A folder location dialog appears.
  2. Select the folder for the LISA project, and then click
    Open
    .
  3. Click
    Next
    through the wizard steps.
The LISA project is imported as a module.
Create Virtual Services
You can create virtual services from RR pair files, Swagger files, or from MAR files.
Create from RR Pairs
Follow these steps:
  1. In IntelliJ IDEA, in the folder that you created in the imported LISA project, right-click the RR pair, and then select
    Create Virtual Service
    .
    The following image shows this option:
    CreateVSFromRRPair
    You can also create a virtual service from an RR pair file by dragging by dropping the file onto the virtual service.
  2. On the
    Create Virtual Service from RR pair
    window, complete the following fields, and then click
    OK
    :
    Target VSE
    The name of the target virtual service.
    Example:
    VSE
    Required:
    Yes
    Folder
    The location to save this virtual service.
    Example:
    /Applications/CA/DevTest/Projects/Bank v6/Data/rrpair
    Required:
    Yes
    Service Name
    The name for this virtual service.
    Required:
    No
    Note:
    If you do not provide a service name, DevTest dynamically assigns one.
    Port
    The port name for this virtual service.
    Required:
    No
    Note:
    If you do not provide a port, DevTest dynamically assigns one.
    Use SSL
    Defines whether this virtual service uses SSL.
    Default:
    Cleared
The virtual service is created.
Create from Swagger Files
Follow these steps:
  1. In IntelliJ IDEA, in the folder that you created in the imported LISA project, right-click the Swagger YAML file, and then select
    Create Virtual Service
    .
    The following image illustrates this step:
    CreateVSFromSwagger
    You can also create a virtual service from a Swagger file by dragging by dropping the file onto the virtual service.
  2. On the
    Create Virtual Service from Swagger File
    window, complete the following fields, and then click
    OK
    :
    Target VSE
    The name of the target virtual service.
    Example:
    VSE
    Required:
    Yes
    File
    The location to save this virtual service.
    Example:
    /Applications/CA/DevTest/Projects/Bank v6/Data/swagger_v2.yaml
    Required:
    Yes
    Service Name
    The name for this virtual service.
    Required:
    No
    Note:
    If you do not provide a service name, DevTest dynamically assigns one.
    Port
    The port name for this virtual service.
    Required:
    No
    Note:
    If you do not provide a port, DevTest dynamically assigns one.
    Use SSL
    Defines whether this virtual service uses SSL.
    Default:
    Cleared
The virtual service is created.
Create from MAR Files
You can create a virtual service from a MAR file using one of the following methods:
  • Drag-and-drop the MAR file onto the virtual service.
  • In IntelliJ IDEA, in the folder that you created in the imported LISA project, right-click the MAR file, select
    Deploy/Redeploy MAR to, VSE
    .
    The following image illustrates this step:
    CreateVSFromMAR
The virtual service is created.
Manage Virtual Services
Virtual services are displayed in the VSE Manager view. Clients, such as workstations, portals, and APIs, can take the following actions on virtual services using this view:
  • View the list of virtual services.
  • Hide/unhide columns in the view.
  • Start and stop virtual services.
  • Update virtual services.
  • Edit the properties of virtual services.
  • Undeploy virtual services.
Before you can use the VSE Manager view, ensure that the LISA project has been imported into IntelliJ IDEA.
View the List of Virtual Services
At the bottom bar of the IntelliJ IDEA window, click the
VSE Manager
tab.
The following image shows this tab:
List of Virtual Services
The VSE Manager view displays. The following image shows the
Summary
subtab, which lists the virtual services:
Summary subtab
To ensure that the VSE Manager view displays the latest summary of virtual services, configure the VSE Manager plugin to periodically update this list.
Start and Stop Virtual Services
On the
Summary
subtab, right-click a virtual service, and then select the
Start
or
Stop
action. The following image shows these options:
Start or Stop Services
You can also use click the
Start
and
Stop
icons on the left side toolbar.
Edit the Properties for Virtual Services
You can edit the properties of a virtual service using one of the following methods:
  • Inline on the
    Summary
    subtab. Click the item that you want to edit, and then select an option from the drop-down. The following image shows how to edit the virtual service in line:
    Properties View
  • In a separate view. Complete the following steps:
    1. On the
      Summary
      subtab, right-click the virtual service for which you want to edit properties, and then select the
      Properties
      action. The following image shows this option:
      Properties Option
      You can also use click the
      Edit Properties
      icon on the left side toolbar.
    2. Edit the properties of the virtual services. The following image shows how to edit the virtual service from the
      Properties
      window:
      Properties Window
Update Virtual Services
Update virtual services by dragging and dropping RR Pair files or MAR files onto the virtual service. You cannot update virtual services using Swagger specifications.
Dragging and dropping MAR files onto virtual services updates only the virtual service contents.
Undeploy Virtual Services
From the VSE Manager view, on the
Summary
subtab, right-click the virtual service that you want to undeploy, and then select the
Undeploy
action.
Log Requests and Responses
You can log requests and responses on the
Console
subtab. The following image shows this subtab:
Console subtab
Uninstall the VSE Manager Plugin for IntelliJ IDEA
(On Mac) Follow these steps:
  1. In the IntelliJ IDEA Editor, go to
    IntelliJ IDEA, Preferences, Plugins
    .
  2. On the
    Plugins
    page, click the
    Install
    tab, search for the VSE Manager plugin, and then select the
    VSE Manager
    plugin.
    The following image illustrates this step:
    VSE Plugins Installed
  3. Click the
    Menu
    option, and then select the
    Uninstall/Disable
    option.
    The following image illustrates this step:
    Uninstall from Mac
    IntelliJ IDEA automatically prompts for a restart.
  4. Follow the prompts to remove the plugin from IntelliJ IDEA.
The VSE Manager plugin is uninstalled.
(On Windows) Follow these steps:
  1. In the IntelliJ IDEA Editor, go to
    File, Settings
    .
    The following image illustrates this step:
    Windows uninstall plugin
  2. Locate the
    VSEManager
    plugin.
    The following image illustrates this step:
    Settings Plugin Uninstall
  3. Select the
    Uninstall
    option from the menu. The following image illustrates this step:
    The following image illustrates this step:
    Settings Plugin Uninstall 2
    IntelliJ IDEA automatically prompts for a restart.
  4. Follow the prompts to remove the plugin from IntelliJ IDEA.
The VSE Manager plugin is uninstalled.