Launching Aspire (Aspire 2)

From wiki.searchtechnologies.com
Jump to: navigation, search

For Information on Aspire 3.1 Click Here

Install Aspire

Follow steps at: Download and Install to install Aspire.

Starting Up Aspire

To start Aspire, execute the "startup" script in the "bin" directory.

Linux

Set your working directory to your Aspire distribution and then execute "bin/startup.sh":

$ cd my-aspire/target/my-aspire-1.0-SNAPSHOT-distribution.dir
$ bin/startup.sh
Removing Felix-Cache and AppBundle-Cache directories
 
************************************************************************
*
* ASPIRE BOOTLOADER
*
* Bundle id : 10
*
* Location  : file:bundles/boot/aspire-bootloader-2.2.2.jar
*

2014-02-04T14:24:22Z INFO [BOOTLOADER]: Maven repository: stPublic - http://repository.searchtechnologies.com/artifactory/simple/community-public/
2014-02-04T14:24:22Z INFO [BOOTLOADER]: Maven local repository: /home/aspire/.m2/repository
2014-02-04T14:24:22Z INFO [BOOTLOADER]: Maven update policy: always
2014-02-04T14:24:22Z INFO [BOOTLOADER]: Default version: 2.0
2014-02-04T14:24:22Z INFO [BOOTLOADER]: Fetching: com.searchtechnologies.aspire:aspire-application:2.0
2014-02-04T14:24:25Z INFO [AspireActivator]: Starting bundle: 11 - file:/home/aspire/.m2/repository/com/searchtechnologies/aspire/aspire-application/2.0/aspire-application-2.0.jar
2014-02-04T14:24:25Z INFO [aspire]: Settings successfully set on OSGi Configuration Admin service
log4j:WARN No appenders could be found for logger (org.apache.zookeeper.server.ZooKeeperServer).
log4j:WARN Please initialize the log4j system properly.
2014-02-04T14:24:25Z INFO [aspire]: Starting embedded ZooKeeper server at port 1112
2014-02-04T14:24:32Z INFO [aspire]: Embedded ZooKeeper server started on port 1112
2014-02-04T14:24:32Z INFO [aspire]: Working Directory: /home/aspire/my-aspire/target/my-aspire-2.0-SNAPSHOT-distribution.dir
2014-02-04T14:24:32Z INFO [aspire]: Aspire Home: /home/aspire/my-aspire/target/my-aspire-2.0-SNAPSHOT-distribution.dir
2014-02-04T14:24:32Z INFO [aspire]: Using settings file: /home/aspire/my-aspire/target/my-aspire-2.0-SNAPSHOT-distribution.dir/config/settings.xml
2014-02-04T14:24:32Z INFO [aspire]: Aspire Logs: /home/aspire/my-aspire/target/my-aspire-2.0-SNAPSHOT-distribution.dir/log
2014-02-04T14:24:32Z INFO [AspireActivator]: Started component factory: aspire-application (bundle 11)
Felix> 2014-02-04T14:24:32Z INFO [aspire]: Maven repository: stPublic - http://repository.searchtechnologies.com/artifactory/simple/community-public/
2014-02-04T14:24:32Z INFO [aspire]: Maven local repository: /home/aspire/.m2/repository
2014-02-04T14:24:32Z INFO [aspire]: Maven update policy: always
2014-02-04T14:24:32Z INFO [aspire]: Default version: 2.0
2014-02-04T14:24:32Z INFO [aspire]: Starting scheduler (enabled)
2014-02-04T14:24:32Z INFO [aspire]: ZooKeeper connection established
2014-02-04T14:24:33Z INFO [aspire]: AUTOSTART: Application -> com.searchtechnologies.aspire:app-workflow-manager (N/A)
2014-02-04T14:24:33Z INFO [aspire]: Starting appBundle: com.searchtechnologies.aspire:app-workflow-manager
2014-02-04T14:24:33Z INFO [aspire]: Fetching: com.searchtechnologies.aspire:app-workflow-manager:2.0
2014-02-04T14:24:34Z INFO [aspire]: Loaded factory com.searchtechnologies.aspire:app-workflow-manager:2.0 (jar file file:/C:/Users/Administrator/.m2/repository/com/searchtechnologies/aspire/app-workflow-manager/2.0/app-workflow-manager-2.0.jar) using repository MavenRepository[/home/aspire/.m2/repository].
2014-02-04T14:24:34Z INFO [aspire]: Registering component: /Workflow
2014-02-04T14:24:34Z INFO [/Workflow]: Starting component: aspire-business-rules  (Name: WfManager)
2014-02-04T14:24:34Z INFO [aspire]: Fetching: com.searchtechnologies.aspire:aspire-business-rules:2.0
2014-02-04T14:24:35Z INFO [aspire]: Starting bundle: 12 - file:/C:/Users/Administrator/.m2/repository/com/searchtechnologies/aspire/aspire-business-rules/2.0/aspire-business-rules-2.0.jar
2014-02-04T14:24:35Z INFO [aspire]: Started component factory: aspire-business-rules (bundle 12)
2014-02-04T14:24:35Z INFO [aspire]: Loaded factory com.searchtechnologies.aspire:aspire-business-rules:2.0 (jar file file:/C:/Users/Administrator/.m2/repository/com/searchtechnologies/aspire/aspire-business-rules/2.0/aspire-business-rules-2.0.jar) using repository MavenRepository[/home/aspire/.m2/repository].
2014-02-04T14:24:35Z INFO [aspire]: Registering component: /Workflow/WfManager
2014-02-04T14:24:35Z WARN [/Workflow/WfManager]: Creation of custom rules enabled
2014-02-04T14:24:35Z INFO [/Workflow/WfManager]: Loaded 0 libraries from directory: /home/aspire/my-aspire/target/my-aspire-2.0-SNAPSHOT-distribution.dir/config/workflow-libraries
2014-02-04T14:24:35Z INFO [/Workflow/WfManager]: Template file: /home/aspire/my-aspire/target/my-aspire-2.0-SNAPSHOT-distribution.dir/cache/appbundles/com.searchtechnologies.aspire/app-workflow-manager/2.0/data/templates.xml
2014-02-04T14:24:35Z INFO [/Workflow]: Installed component: /Workflow/WfManager
2014-02-04T14:24:35Z INFO [aspire]: Successfully started appBundle: /Workflow (location: com.searchtechnologies.aspire:app-workflow-manager)
2014-02-04T14:24:35Z INFO [aspire]: AUTOSTART: Complete

Microsoft Windows from the Command Prompt

Set your working directory to your Aspire distribution and then execute "bin\startup.bat":

Removing Felix-Cache and AppBundle-Cache directories
Java HotSpot(TM) 64-Bit Server VM warning: ignoring option MaxPermSize=256m; sup
port was removed in 8.0
************************************************************************
*
* ASPIRE BOOTLOADER
*
* Bundle id : 10
*
* Location  : file:bundles/boot/aspire-bootloader-2.1.1.jar
*
2015-04-14T21:28:59Z INFO [BOOTLOADER]: Maven repository: stPublic - http://repository.searchtechnologies.com/artifactory/simple/community-public/
2015-04-14T21:28:59Z INFO [BOOTLOADER]: Maven local repository: C:\Users\foo/.m2/repository
2015-04-14T21:28:59Z INFO [BOOTLOADER]: Maven update policy: always
2015-04-14T21:28:59Z INFO [BOOTLOADER]: Default version: 2.1.1
2015-04-14T21:28:59Z INFO [BOOTLOADER]: Fetching: com.searchtechnologies.aspire:aspire-application:2.1.1
2015-04-14T21:29:05Z INFO [AspireActivator]: Starting bundle: 11 - file:/C:/Users/foo/.m2/repository/com/searchtechnologies/aspire/aspire-application/2.1.1/aspire application-2.1.1.jar
2015-04-14T21:29:06Z INFO [aspire]: Settings successfully set on OSGi Configuration Admin service
2015-04-14T21:29:06Z INFO [aspire]: Working directory: C:\Aspire\aspire-distribution-2.1.1\aspire-distribution-2.1.1
2015-04-14T21:29:06Z INFO [aspire]: Aspire home: C:\Aspire\aspire-distribution-2.1.1\aspire-distribution-2.1.1
2015-04-14T21:29:06Z INFO [aspire]: Using settings file: C:\Aspire\aspire-distribution-2.1.1\aspire-distribution-2.1.1\config\settings.xml
2015-04-14T21:29:06Z INFO [aspire]: Aspire logs: C:\Aspire\aspire-distribution-2.1.1\aspire-distribution-2.1.1/log
2015-04-14T21:29:06Z INFO [AspireActivator]: Started component factory: aspire-application (bundle 11)Felix> 
2015-04-14T21:29:06Z INFO [aspire]: Maven repository: stPublic - http://repository.searchtechnologies.com/artifactory/simple/community-public/
2015-04-14T21:29:06Z INFO [aspire]: Maven local repository: C:\Users\foo/.m2/repository
2015-04-14T21:29:06Z INFO [aspire]: Maven update policy: always
2015-04-14T21:29:06Z INFO [aspire]: Default version: 2.1.1
2015-04-14T21:29:06Z INFO [aspire]: Fetching: com.searchtechnologies.aspire:aspire-dcm-enterprise:2.1.1
2015-04-14T21:29:08Z INFO [aspire]: AUTOSTART: Application -> com.searchtechnologies.aspire:app-workflow-manager (N/A)
2015-04-14T21:29:08Z INFO [aspire]: Starting appBundle: com.searchtechnologies.aspire:app-workflow-manager
2015-04-14T21:29:08Z INFO [aspire]: Fetching: com.searchtechnologies.aspire:app-workflow-manager:2.1.1
2015-04-14T21:29:08Z INFO [aspire]: Loaded factory com.searchtechnologies.aspire:app-workflow-manager:2.1.1 (jar file file:/C:/Users/foo/.m2/repository/com/searchtechnologies/aspire/app-workflow-manager/2.1.1/app-workflow-manager-2.1.1.jar) using repository MavenRepository[C:\Users\foo/.m2/repository].
2015-04-14T21:29:08Z INFO [aspire]: Registering component: /Workflow
2015-04-14T21:29:08Z INFO [/Workflow]: Starting component: aspire-business-rules(Name: WfManager)
2015-04-14T21:29:08Z INFO [aspire]: Fetching: com.searchtechnologies.aspire:aspire-business-rules:2.1.1
2015-04-14T21:29:09Z INFO [aspire]: Starting bundle: 12 - file:/C:/Users/foo/.m2/repository/com/searchtechnologies/aspire/aspire-business-rules/2.1.1/aspire-business-rules-2.1.1.jar
2015-04-14T21:29:09Z INFO [aspire]: Started component factory: aspire-business-rules (bundle 12)
2015-04-14T21:29:09Z INFO [aspire]: Loaded factory com.searchtechnologies.aspire:aspire-business-rules:2.1.1 (jar file file:/C:/Users/foo/.m2/repository/com/searchtechnologies/aspire/aspire-business-rules/2.1.1/aspire-business-rules-2.1.1.jar) using repository MavenRepository[C:\Users\foo/.m2/repository].
2015-04-14T21:29:09Z INFO [aspire]: Registering component: /Workflow/WfManager
2015-04-14T21:29:09Z WARN [/Workflow/WfManager]: Creation of custom rules enabled
2015-04-14T21:29:09Z INFO [/Workflow/WfManager]: Loaded 0 libraries from directory: C:\Aspire\aspire-distribution-2.1.1\aspire-distribution-2.1.1\config/workflow-libraries
2015-04-14T21:29:09Z INFO [/Workflow/WfManager]: Template file: C:\Aspire\aspire-distribution-2.1.1\aspire-distribution-2.1.1/cache/appbundles/com.searchtechnologies.aspire/app-workflow-manager/2.1.1/data/templates.xml
2015-04-14T21:29:09Z INFO [/Workflow/WfManager]: Starting workflow libraries update thread. Poll: 15000ms
2015-04-14T21:29:09Z INFO [/Workflow/WfManager]: Reloading libraries after 15000ms
2015-04-14T21:29:09Z INFO [/Workflow]: Installed component: /Workflow/WfManager
2015-04-14T21:29:09Z INFO [aspire]: Successfully started appBundle: /Workflow (location: com.searchtechnologies.aspire:app-workflow-manager)
2015-04-14T21:29:09Z INFO [aspire]: AUTOSTART: Completelog4j:WARN No appenders could be found for logger (org.quartz.impl.StdSchedulerFactory).log4j:WARN Please initialize the log4j system properly.
2015-04-14T21:29:09Z INFO [aspire]: Starting scheduler (enabled)
2015-04-14T21:29:09Z INFO [aspire]:
            _              _
           / \   ___ _ __ (_)_ __ ___
          / _ \ / __| '_ \| | '__/ _ \
         / ___ \\__ \ |_) | | | |  __/
        /_/   \_\___/ .__/|_|_|  \___|
                    |_|
Aspire is now running

When to Re-Start Aspire

Once Aspire is running, only changes to base configuration settings or the Aspire launcher require a restart. The following rules apply:

  • Changes to anything in the ‘bin’ folder, or changes in config/felix.properties or config/settings.xml require an Aspire restart to take effect.
  • Anything else shouldn’t require a whole system restart, but may require a reload of specific components.

This is thanks to OSGi, and one of the nicest features of Aspire. You can change the configuration of components and just reload them dynamically.



Shutting Down Aspire

There are different methods for shutting down Aspire.

Shutdown by URL

To shutdown your server you can execute the following URL in a browser:

http://localhost:50505/aspire?cmd=shutdown

Shutdown using the Debug Interface

Shutdown on Debug Interface

There is also a shutdown link on the debug interface.

  1. Go to http://localhost:50505/aspire.
  2. Click on the shutdown link.


Shutdown at the Console

If you started Aspire at a console window, you can shut it down by simply typing "shutdown" in the console window.

This works because the default installation of Aspire starts up a Felix console command prompt, and "shutdown" is a Felix console command for shutting down.

> bin\startup.bat
Removing Felix-Cache and AppBundle-Cache directories
-> Starting bundle: 9 - file:bundles/aspire/aspire-application-1.0-SNAPSHOT.jar
Settings (org.apache.felix.webconsole.internal.servlet.OsgiManager):  {password=admin, manager.root=/osgi, username=admin}
Started component factory: aspire-application (bundle 9)
Set update policy to always
AUTOSTART: No applications to start
shutdown
-> Stopping bundle: 9 - file:bundles/aspire/aspire-application-1.0-SNAPSHOT.jar
Stopped component factory: aspire-application (bundle 9)
>

Shutdown using the Windows Service

And finally, if you have Aspire installed as a Windows Service, you can shut it down using the Service "Stop" command.

Installing Aspire as a Service

Once you have Aspire running in production, you can install it as a service in a server. This way, any restarts of the server will bring Aspire up as well.

When run as a service, Aspire will run in the background, so it doesn’t require a user to be logged into the server all the time. It allows for more secure environments, as the account running Aspire is normally restricted from all non-Aspire related tasks (not even remote login to the server).

Installing Aspire as a Windows Service

See Running Aspire as a Windows Service (Aspire 2) for step-by-step instructions for running Aspire as a Windows Service.

Installing Aspire as a Linux Service

See Running Aspire as a Linux Service (Aspire 2) for instructions.

Start Aspire Shell

To start Aspire, execute the "aspiresh.sh" or "aspiresh.bat" script in the "bin" directory.

Linux

Set your working directory to your Aspire distribution and then execute "bin/aspiresh.sh" (make sure it has execute permission for your user):

$ cd my-aspire/target/my-aspire-1.0-SNAPSHOT-distribution.dir
$ bin/aspiresh.sh



************************************************************************
*
* ASPIRE BOOTLOADER
*
* Bundle id : 10
*
* Location  : file:bundles/boot/aspire-bootloader-2.2.2-SNAPSHOT.jar
*

Maven update policy: always


Settings (org.apache.felix.webconsole.internal.servlet.OsgiManager):  {password=admin, manager.root=/osgi, username=admin}
Maven update policy: always
Aspire Console Mode
Aspire>

Microsoft Windows from the Command Prompt

Set your working directory to your Aspire distribution and then execute "bin\aspiresh.bat":

$ cd my-aspire\target\my-aspire-1.0-SNAPSHOT-distribution.dir
$ bin\aspiresh.bat
Removing Felix-Cache and AppBundle-Cache directories



************************************************************************
*
* ASPIRE BOOTLOADER
*
* Bundle id : 10
*
* Location  : file:bundles/boot/aspire-bootloader-2.2.2-SNAPSHOT.jar
*

Maven update policy: always


Settings (org.apache.felix.webconsole.internal.servlet.OsgiManager):  {password=admin, manager.root=/osgi, username=admin}
Maven update policy: always
Aspire Console Mode
Aspire>

For more details visit: Aspire Shell

Setting Aspire Home

The Aspire Home is the file system directory where the Aspire installation is installed. This directory should contain several sub-directories such as "bin", "bundles", "resources", etc.

What is Aspire Home Used For?

Aspire Home is used for:

  • Locating configuration files
  • Locating XSL and other resources from the "resources" directory
  • Locating the "log" directory

Aspire Home is used anytime a relative path to a file inside the Aspire installation is required. The Aspire Home directory will be prepended to all such paths.

By default, the settings.xml file loads from "config/settings.xml" located in the Aspire Home directory. The settings.xml file holds environmental information and properties about the Aspire installation as a whole. For more information about the settings.xml file, see [[Settings Configuration (Aspire 2)]|here].

Be aware that there is also a Java System property which can be used to set the location of the settings.xml file as well. It is "com.searchtechnologies.aspire.settings". For example:

  java -Dcom.searchtechnologies.aspire.settings=/test/settings.xml ...

On Microsoft Windows

On Windows, there are several ways to set the Aspire Home directory.

  1. Set the environment variable ASPIRE_HOME to the full path of the Aspire Home directory.
  2. Set your working directory to either the Aspire Home directory or the binary directory before executing "bin/startup.bat"
    • If no environment variable is set, the startup script will try and validate that your working directory (or the parent of your working directory) is a valid Aspire installation. If it is, it automatically sets Aspire Home to that directory.
  3. Edit the "bin/startup.bat" and change the "java" call so it passes the correct directory to the Java JVM.

The Java JVM System property which specifies the Aspire Home directory is com.searchtechnologies.aspire.home. This can be set with a command-line argument when executing the "java" command as follows:

  "-Dcom.searchtechnologies.aspire.home={home-directory}"

On Linux

In a bash shell on Linux, Aspire Home may be set by placing commands similar to the following in a script used to start Felix, or the user's profile:

if [ "${ASPIRE_HOME}" = "" ]
then
   # Set ASPIRE_HOME
   export ASPIRE_HOME=/home/aspire
 fi