Skip to content

Commit

Permalink
Added configuration from svn and resolved issue.
Browse files Browse the repository at this point in the history
  • Loading branch information
abimarank committed Jan 29, 2015
1 parent 57900f7 commit 897dfc4
Show file tree
Hide file tree
Showing 393 changed files with 72,336 additions and 3,383 deletions.
73 changes: 73 additions & 0 deletions INSTALL.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
Installing WSO2 API Manager (AM)
=================================


Running WSO2 API Manager in standalone mode
===========================================
1. The directory containing this INSTALL.txt file will be the root and it will be
treated as Carbon home directory and let it be CARBON_HOME.

2. All the shell scripts and .bat files are available in CARBON_HOME/bin folder.

3. To start WSO2 AM one can use either wso2server.sh or daemon.sh in all Unix
systems & wso2server.bat file on Windows operating systems.

4. Either of the following commands can be used to start AM
i) ./wso2server.sh {console|start|stop|restart|status|dump|version}
ii) wso2server.bat {start|stop|version}

Usage: wso2server.sh [command] [options] [system-properties]

command:
--start Start AM as a Unix daemon in the background
--console Start AM as a Unix daemon in the foreground
--stop Stop the AM Unix daemon
--restart Restart the AM Unix daemon
--version What version of the AM server are you running

options:
--debug <port> Start the server in remote debugging mode.
port: The remote debugging port.
--cleanRegistry Clean registry space
--reset Clean the cache & component repository and the
registry space

system-properties:
-DhttpPort Overrides the HTTP port defined in the
repository/conf/tomcat/catalina-server.xml file
-DhttpsPort Overrides the HTTPS port defined in the
repository/conf/tomcat/catalina-server.xml file
-DSynapseServerName=[server-name]
Server name of the synapse server
-DosgiConsole=[port]
Start Carbon with Equinox OSGi console.
If the optional 'port' parameter is provided, a
telnet port will be opened
-DosgiDebugOptions=[options-file]
Start Carbon with OSGi debugging enabled.
If the optional 'options-file is provided, the
OSGi debug options will be loaded from it.
-Dsetup Clean the Registry database & other
configuration, recreate DB, re-populate the
configuration, and start Carbon
-Dcarbon.registry.root
The root of the Registry used by
this Carbon instance
-Dweb.location The directory into which UI artifacts
included in an Axis2 AAR file are extracted to

System Requirements
=======================
1. Minimum memory - 1GB
2. Processor - Pentium 800MHz or equivalent at minimum
3. Java SE Development Kit 1.6.24 or higher
4. The Management Console requires you to enable Javascript of the Web browser,
with MS IE 7. In addition to JavaScript, ActiveX should also be enabled
with IE. This can be achieved by setting your security level to
medium or lower.
5. To compile and run the sample clients, an Ant version is required. Ant 1.7.0
version is recommended
6. To build WSO2 AM from the Source distribution, it is necessary that you have
JDK 1.6.x version and Maven 3.0.0 or later


648 changes: 648 additions & 0 deletions LICENSE.txt

Large diffs are not rendered by default.

137 changes: 137 additions & 0 deletions README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
================================================================================
WSO2 API Manager
================================================================================

WSO2 API Manager is a powerful platform for creating, managing, consuming and
monitoring web APIs. It combines tried and tested SOA best practices with modern
day API management principles to solve a wide range of enterprise challenges
associated with API provisioning, governance and integration.

WSO2 API Manager consists of several loosely coupled modules.

* API publisher
* API store
* API gateway
* API Key Manager

The API publisher module allows API publishers to easily define APIs and manage them
using a strong governance model which consists of well-established concepts such as
versioning and lifecycles. API consumers can use the API store module to discover
published, production-ready APIs and access them in a secure and reliable manner
using unique API keys. The built-in API gateway module provides powerful tools to
secure and control the load on individual APIs.

WSO2 API Manager is based on the revolutionary WSO2 Carbon [Middleware a' la carte]
framework. All the major features have been developed as reusable Carbon
components.

To learn more about WSO2 API Manager please visit http://wso2.com/products/api-manager.

Key Features
=============

* API publishers:
- Simple web-based UI for defining APIs
- Easily modify existing APIs and move them across life cycle states
- Specify and attach documentation to defined APIs
- Create new versions of existing APIs
- Specify SLAs under which each API is exposed to the consumers
- Track and monitor API usage

* API consumers:
- Rich web portal to discover published APIs
- Create applications, subscribe and obtain API keys
- Browse documentation and samples associated with each API
- Try APIs on-line before using them
- Rate APIs and comment on their features, usability and other related aspects

System Requirements
==================================

1. Minimum memory - 1GB
2. Processor - Pentium 800MHz or equivalent at minimum
3. Java SE Development Kit 1.6.0_24 or higher
4. The Management Console requires you to enable Javascript of the Web browser,
with MS IE 6 and 7. In addition to JavaScript, ActiveX should also be enabled
with IE. This can be achieved by setting your security level to
medium or lower.
5. To compile and run the sample clients, an Ant version is required. Ant 1.7.0
version is recommended
6. To build WSO2 API Manager from the Source distribution, it is necessary that you have
JDK 1.6.x version and Maven 3.0.0 or later

Installation & Running
==================================

1. Extract the wso2am-1.8.0.zip and go to the 'bin' directory
2. Run the wso2server.sh or wso2server.bat as appropriate
3. API Publisher web application is running at http://localhost:9763/publisher. You may login
to the Publisher using the default administrator credentials (user: admin, pass: admin).
4. API Store web application is running at http://localhost:9763/store. You may login
to the Store using the default administrator credentials (user: admin, pass: admin).

Documentation
==============

On-line product documentation is available at:
http://docs.wso2.org/wiki/display/AM180/WSO2+API+Manager+Documentation

Support
==================================

WSO2 Inc. offers a variety of development and production support
programs, ranging from Web-based support up through normal business
hours, to premium 24x7 phone support.

For additional support information please refer to http://wso2.com/support

For more information on WSO2 API Manager please visit http://wso2.com/products/api-manager

Known issues of WSO2 API Manager
==================================

All known issues of WSO2 API Manager are filed at:

https://wso2.org/jira/secure/IssueNavigator.jspa?requestId=10810

Issue Tracker
==================================

Help us make our software better. Please submit any bug reports or feature
requests through the WSO2 JIRA system:

https://wso2.org/jira/browse/APIMANAGER


Crypto Notice
==================================

This distribution includes cryptographic software. The country in
which you currently reside may have restrictions on the import,
possession, use, and/or re-export to another country, of
encryption software. BEFORE using any encryption software, please
check your country's laws, regulations and policies concerning the
import, possession, or use, and re-export of encryption software, to
see if this is permitted. See <http://www.wassenaar.org/> for more
information.

The U.S. Government Department of Commerce, Bureau of Industry and
Security (BIS), has classified this software as Export Commodity
Control Number (ECCN) 5D002.C.1, which includes information security
software using or performing cryptographic functions with asymmetric
algorithms. The form and manner of this Apache Software Foundation
distribution makes it eligible for export under the License Exception
ENC Technology Software Unrestricted (TSU) exception (see the BIS
Export Administration Regulations, Section 740.13) for both object
code and source code.

The following provides more details on the included cryptographic
software:

Apache Rampart : http://ws.apache.org/rampart/
Apache WSS4J : http://ws.apache.org/wss4j/
Apache Santuario : http://santuario.apache.org/
Bouncycastle : http://www.bouncycastle.org/

--------------------------------------------------------------------------------
(c) Copyright 2014 WSO2 Inc.
73 changes: 73 additions & 0 deletions config/BAM/bamClient/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---------------------------------------------------------------------------------
Requirements
---------------------------------------------------------------------------------

1. WSO2 BAM-2.0.0-ALPHA2
2. Apache Ant
3. Java Runtime Environment

---------------------------------------------------------------------------------
Configuring API Manager
---------------------------------------------------------------------------------
To enable API statistics collection you need to configure the following properties in the
api-manager.xml file of API Manager.

<!--
Enable/Disable the API usage tracker.
-->
<Enabled>true</Enabled>

<!--
JNDI name of the data source to be used for getting BAM statistics.This data source should
be defined in the master-datasources.xml file in conf/datasources directory.
-->

<DataSourceName>jdbc/WSO2AM_STATS_DB</DataSourceName>

And you need to configure the datasource definition in the master-datasources.xml file[in conf/datasources]
of API Manager.

<datasource>
<name>WSO2AM_STATS_DB</name>
<description>The datasource used for getting statistics to API Manager</description>
<jndiConfig>
<name>jdbc/WSO2AM_STATS_DB</name> //This jndi lookup name should equal to the DataSourceName defined in api-manager.xml as above
</jndiConfig>
<definition type="RDBMS">
<configuration>
<url>jdbc:h2:<BAM_HOME>/repository/database/APIMGTSTATS_DB;AUTO_SERVER=TRUE</url> //JDBC URL to query remote JDBC database
<username>wso2carbon</username>
<password>wso2carbon</password>
<driverClassName>org.h2.Driver</driverClassName>
<maxActive>50</maxActive>
<maxWait>60000</maxWait>
<testOnBorrow>true</testOnBorrow>
<validationQuery>SELECT 1</validationQuery>
<validationInterval>30000</validationInterval>
</configuration>
</definition>
</datasource>


NOTE: 1) Replace <BAM_HOME> with the absolute path to the installation directory of BAM,in JDBC URL
entry of above datasource definition.

2) <DataSourceName> of <APIUsageTracking> entry in api-manager.xml should equal to JNDI config name
of master-datasources.xml


---------------------------------------------------------------------------------
Configuring BAM
---------------------------------------------------------------------------------

1.Copy StatClient directory into BAM_HOME
2.Change port offset to 1 by editing the repository/conf/carbon.xml
3.Start WSO2 BAM server
4.Go to StatClient directory and run "ant initialize_column_family_datastore" command (You need to
have an Internet connection.)
5.Finally you can see the message - "BAM configured successfully for collecting API stats"
6.Now start deploying samples & invoking them. Your invocation statistics should be visible under,
- APIs -> All Statistics
- My APIs -> Statistics
- APIs -> All -> [YOUR API SAMPLE NAME] -> 'Versions' tab
- APIs -> All -> [YOUR API SAMPLE NAME] -> 'Users' tab
Loading

0 comments on commit 897dfc4

Please sign in to comment.