tib_tra_addon_auth_user

7/31/2019 tib_tra_addon_auth_user

1/21

TIBCO Runtime Agent

Authentication API

Users Guide

Software Release 5.7.2

November 2011


2/21

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUN DLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDEDOR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTION ALITY (OR PROVIDE LIMITEDADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLEDSOFTWARE IS NOT LICEN SED TO BE USED OR ACCESSED BY AN Y OTHER TIBCO SOFTWARE OR FORAN Y OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF ALICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSEAGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USERLICENSE AGREEMENT WH ICH IS DISPLAYED DURING D OWN LOAD OR IN STALLATION OF THESOFTWARE (AND WH ICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARELICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATEDIN TH E LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMSAN D CON DITIONS, AND YOUR USE HEREOF SHA LL CONSTITUTE ACCEPTANCE OF AND A NAGREEMENT TO BE BOUN D BY THE SAME.

This documen t contains confidential information that is subject to U.S. and international copyright laws an dtreaties. No p art of this document m ay be reprod uced in any form without th e written auth orization of TIBCOSoftware Inc.

TIBCO, The Pow er of No w, TIBCO Ad ap ter, TIBCO Ad min istrator , TIBCO BusinessWor ks, TIBCO ActiveMatr ixBusin essWorks , TIBCO Design er, TIBCO Enterpr ise Message Service, TIBCO Rend ezvou s, TIBCO Repositor y,and TIBCO Runtime Agent are either registered tra dem arks or tra dem arks of TIBCO Software Inc. in the United

States and/ or other countries.EJB, Java EE, J2EE, and all Java-based tr adem arks an d logos are trad emarks or registered trad emarks of SunMicrosystems, Inc. in the U.S. and other countries.

All other produ ct and company nam es and m arks mentioned in this document are the property of theirrespective owners and are mentioned for identification pu rposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATIN G SYSTEMS. HO WEVER, NOT ALLOPERATIN G SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAMETIME. SEE THE README FILE FOR THE AVAILABILITY OF TH IS SOFTWARE VERSION ON A SPECIFICOPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS ORIMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE, OR NON -INFRINGEMENT.

THIS DOCUMEN T COULD INCLUDE TECHNICAL IN ACCURACIES OR TYPOGRAPH ICAL ERRORS.CHA NGES ARE PERIODICALLY ADDED TO THE IN FORMATION H EREIN; THESE CHAN GES WILL BEINCORPO RATED IN NEW EDITIONS OF TH IS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKEIMPROVEMENTS AND / OR CHAN GES IN THE PRODUCT(S) AN D/ OR THE PROGRAM(S) DESCRIBED INTHIS DOCUMEN T AT AN Y TIME.

THE CON TENTS OF THIS DOCUMENT MA Y BE MODIFIED AND/ OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCU MENTATION WHICH ACCOMPA NIES THIS SOFTWARE, INCLUDINGBUT N OT LIMITED TO A NY RELEASE NO TES AND "READ ME" FILES.

This Prod uct is covered b y U.S. Patent N o. 6,970,981.

Copyright 1999-2011 TIBCO Software Inc. ALL RIGHTS RESERVED.

TIBCO Software Inc. Confidential Information


3/21

TIBCO Runtime Agent Authentication API Users Guide

| iii

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi

TIBCO Runtime Agent Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi

Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiiConnecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

How to Access All TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Chapter 1 Using the TIBCO Runtime Agent Authentication API . . . . . . . . . . . . . . . . . . . . . . . . . .1

Feature Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2API Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Getting Started with the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Compiling Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Running Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Running the Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Using the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Common Aspects of the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Objects and Factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

AuthenticationSubject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

RoleMembershipConfig and RoleMembership. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

AuthUtils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

General Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9


4/21


iv | Contents


5/21


|v

Preface

This manu al explains how to use TIBCO Runtime Agent Au thentication API.

Topics

Related Documentation, page vi

Typograph ical Conventions, page viii

Connecting w ith TIBCO Resources, page xi


6/21


vi | Related Documentation

Related Documentation

This section lists documen tation resources you may find u seful.

TIBCO Runtime Agent Documentation

The TIBCO Run time Agent software suite is a prerequ isite for other TIBCO

software products. In ad dition to Runtime Agent comp onents, the software suite

includ es the third-par ty libraries used by other TIBCO p rodu cts, TIBCO

Designer, Java Runtime Environment (JRE), TIBCO Rend ezvou s, and TIBCOHawk.

The following docum ents form the TIBCO Runtime Agent d ocumen tation set:

TIBCO Runtime A gent Installation Read this man ual for instructions on site

preparation an d installation.

TIBCO Ru ntime Agent Installing Into a Cluster Read th is manu al for

instructions on installing TIBCO ap plications into a cluster environment.

TIBCO Runtime Agent Upgrading to Release 5.7 Read this manu al for

instructions on up grad ing from release 5.x to release 5.7.

TIBCO Runtime Agent Domain Utility Users Guide Read this manu al for

instructions on using TIBCO Domain Utility to create and manage

adm inistration dom ains.

TIBCO Runtime Agent Scripting Deployment Users Guide Read this manu al for

instructions on using the App Manage scripting utility to deploy app lications.

TIBCO Runtime Agent Authentication API User's Guide Read th is manu al for

instructions on using Au thentication API.

TIBCO Runtime Agent Release Notes Read the release notes for a list of new and

changed features. This documen t also contains lists of know n issues and

closed issues for this release.

Other TIBCO Product Documentation

You may find it useful to read the d ocumen tation for the following TIBCO

products:

TIBCO Administrator : TIBCO Administrator allows you to manage users,

machines and ap plications defined in a TIBCO adm inistration dom ain. The

TIBCO Ad ministrator graphical user interface enables users to d eploy,

mon itor, and start and stop TIBCO ap plications.


7/21


Preface |vii

TIBCO Designer: This graphical user interface is used for designing and

creating integration p roject configurations and building an Enterp rise Archive

(EAR) for the project. The EAR can then be u sed by TIBCO Ad ministrator for

dep loying and runn ing the app lication.

TIBCO Hawk: This is a tool for monitoring and m anaging distributed

applications and operating systems.

TIBCO Rendezvous: Rendezvous enables programs running on many

different kinds of comp uters on a netw ork to comm un icate seamlessly. It

includes tw o m ain components: the Rendezvous ap plication p rogramming

interface (API) in several languages, and the Rendezvou s daem on.

TIBCO Enterprise Message Service: This software lets app lication programs

send and receive messages using the Java Message Service (JMS) protocol. It

also integrates with TIBCO Rendezvous and TIBCO SmartSockets

messaging produ cts.

TIBCO ActiveMatrix BusinessWorks: ActiveMatrix BusinessWorks is a

scalable, extensible, and easy to use integration p latform that a llows you to

develop integration projects. ActiveMatrix BusinessWorks includes a GUI for

defining business processes and an engine that executes the p rocess.

TIBCO Adap ter software: TIBCO Runtime Agent is a prerequisite for TIBCO

Adapter prod ucts. You w ill therefore find TIBCO Ad apter prod uct

documentation useful.


8/21


viii | Typographical Conventions

Typographical Conventions

The following typ ographical conventions are used in this manu al.

Table 1 General Typographical Conventions

Convention Use

ENV_NAME

TIBCO_HOME

TRA_HOME

TIBCO produ cts are installed into an installation environm ent. A prod uct

installed into an installation environm ent does not access comp onents in other

installation environments. Incompatible produ cts and m ultiple instances of the

same p rodu ct must be installed into different installation environments.

An installation environm ent consists of the following prop erties:

Name Identifies the installation environm ent. This name is referenced in

documentation asENV_NAME. On Microsoft Window s, the name is

app end ed to the name of Window s services created by the installer and is a

compon ent of the path to the prod uct shortcut in the Wind ows Start > All

Programs menu .

Path The folder into w hich the prod uct is installed. This folder is referenced

in documentation as TIBCO_HOME.

TIBCO TRA installs into a d irectory within TIBCO_HOME. This d irectory is

referenced in documen tation as TRA_HOME. The d efault value ofTRA_HOME

dep ends on the operating system. For example on Window s systems, the default

value is C:\tibco\tra\5.7 .

code font Code font iden tifies comm and s, code exam ples, filenam es, path nam es, andoutpu t displayed in a comm and w indow. For examp le:

Use MyCommand to start the foo process.

bold code

font

Bold code font is used in the following ways:

In procedures, to indicate what a user types. For example: Type admin .

In large code samples, to indicate the parts of the sample that are ofpar ticular interest.

In comm and syntax, to indicate the default parameter for a command. For

example, if no param eter is specified, MyCommand is enabled:

MyCommand [enable | disable]


9/21


Preface | ix

italic font Italic font is u sed in the following ways:

To indicate a document title. For examp le: See TIBCO ActiveMatrix

BusinessWorks Concepts.

To introduce new terms For example: A portal page may contain several

portlets. Portlets are mini-applications that ru n in a portal.

To indicate a variable in a command or code syntax that you m ust replace.

For example: MyCommand PathName

Key

combinations

Key name separa ted by a p lus sign indicate keys pressed simu ltaneously. For

example: Ctrl+C.

Key names separated by a comma an d sp ace indicate keys pressed one after the

other. For example: Esc, Ctrl+Q.

The note icon ind icates information that is of special interest or importance, for

example, an ad ditional action required only in certain circum stances.

The tip icon ind icates an idea that could be u seful, for example, a way to apply

the information p rovided in the cur rent section to achieve a specific result.

The warn ing icon ind icates the potential for a dam aging situation, for example,

da ta loss or corrup tion if certain steps are taken or n ot taken.

Table 1 General Typographical Convent ions (Contd)

Convention Use

Table 2 Syntax Typographical Conventions

Convention Use

[ ] An op tional item in a comman d or code syntax.

For examp le:

MyCommand [optional_parameter] required_parameter

| A logical OR that separates mu ltiple items of which only one may be chosen.

For examp le, you can select only one of the following p aram eters:

MyCommand para1 | param2 | param3


10/21


x | Typographical Conventions

{ } A logical group of items in a command . Other syntax notations may app earwithin each logical group .

For example, the following command requires two param eters, which can be

either the pair param1 an d param2 , or the pair param3 an d param4 .

MyCommand {param1 param2} | {param3 param4}

In the next examp le, the command requires two parameters. The first param eter

can be either param1 or param2 and the second can be either param3 or param4 :

MyCommand {param1 | param2} {param3 | param4}

In the next example, the comm and can accept either tw o or three param eters.

The first parameter must be param1 . You can op tionally includ e param2 as the

second parameter. And the last param eter is either param3 or param4 .

MyCommand param1 [param2] {param3 | param4}

Table 2 Syntax Typographical Convent ions

Convention Use


11/21


Preface |xi

Connecting with TIBCO Resources

How to Join TIBCOmmunity

TIBCOmmu nity is an online destination for TIBCO custom ers, partners, and

residen t experts, a p lace to share and access the collective experience of the

TIBCO comm un ity. TIBCOm mun ity offers forum s, blogs, and access to a var iety

of resources. To register, go to http:/ / ww w.tibcommunity.com.

How to Access All TIBCO Documentation

After you join TIBCOmm un ity, you can access the docum entation for a ll

supp orted prod uct versions here:

http:/ / docs.tibco.com/ TibcoDoc

How to Contact TIBCO SupportFor comm ents or problems with th is manu al or the software it add resses, please

contact TIBCO Suppor t as follows.

For an overview of TIBCO Supp ort, and information about getting started

with TIBCO Support, visit this site:

http:/ / www.tibco.com/ services/ support

If you already have a valid maintenance or support contract, visit this site:

https:/ / support.tibco.com

Entry to this site requires a user name and p assword . If you d o not have a u ser

nam e, you can request one.
http://www.tibcommunity.com/http://docs.tibco.com/TibcoDochttp://www.tibco.com/services/supporthttps://support.tibco.com/http://www.tibcommunity.com/http://docs.tibco.com/TibcoDochttps://support.tibco.com/http://www.tibco.com/services/support


12/21


xii | Connecting with TIBCO Resources


13/21


|1

Chapter 1 Using the TIBCO Runtime Agent

Authentication API

This chap ter explains the n eed for TIBCO Run time Agent Au thentication API,

and contains instructions for its use.

Topics

Feature Overview, page 2

API Overview, page 3

Getting Started with the API, page 4

Common Aspects of the API, page 6

Best Practices, page 7


14/21


2 | Chapter 1 Using the TIBCO Runtime Agent Authentication API

Feature Overview

This is an API that can be used to create custom scripts and app lications. This APIinclud es Javad ocs, viewable in a w eb browser.

API O i |3


15/21


API Overview |3

API Overview

This API can be used to create custom scripts and app lications. Javad ocs for thisAPI are contained in the following directory:

TRA_HOME/ doc/ au th / javad oc

While most TIBCO Run time Agen t an d TIBCO Run time Agent (TRA)

requirements are add ressed by the capabilities available through Runtim e Agent

Console and other TRA u tilities, this API allows you to p rovide programm atic

access to the functionality available through Runtime Agent Console.

This API provides a fram ework for doing the following:

User au then ticat ion

Retrieve users

Retrieve roles and role memberships

For explana tions of the meaning of variables like TRA_HOME,

TIBCO_DOMAIN_HOME, TIBCO_TRA_VERSION, and so on, please refer to the

table on Typographical Conventions on p age viii of the Preface.



16/21



Getting Started with the API

This section provides information that w ill be useful to you as you begin to w orkwith the API.

Compiling Programs

In order to comp ile your scripts and ap plications, you will need to include the

following jar files in your classpath:

TRA_HOME/lib/TIBCOAuthAPI.jar

Running Programs

In order to run your scripts and app lications, your system mu st meet the

requirements d escribed in th is section.

Running Programs: Environment Variables Required

To run a program or app lication that uses this API , you m ust set the following

environment variables:

TRA_VERSION=TRA_VERSION

TRA_HOME=TRA_HOME

DOMAIN_NAME=Your-Domain-Name

DOMAIN_HOME=TIBCO_DOMAIN_HOME

Running Programs: JAR Files Required

You mu st also ensure that the following JAR files are on you r classpath:

TRA jar files from following directory:

TRA_HOME/lib

These files include TIBCOAuthAPI.jar an d TIBCOAuthAPIimpl.jar

HAWK Jar files from following directory:

TIBCO_HOME/hawk/lib

RV jar files from following directory: TIBCO_HOME/tibrv/8.1/lib

Note th at an API program cannot be run remotely from the comman d-line. You

mu st run it on a machine w here this Authen tication API is installed.

Getting Started with the API |5


17/21


Getting Started with the API |5

TPCL jar files from following directories:

TIBCO_HOME/tpcl/TIBCO_TPCL_VERSION/lib

TIBCO_HOME/tpcl/TIBCO_TPCL_VERSION/jdbc

Running the Samples

A samp le has been p rovided with compile and run scripts. This sample provides

all the environm ent variables required to ru n this program . The sample is

available in the following d irectory:

TRA_HOME/sample/auth

Please refer to the readme.txt in that directory for the instructions on compiling

and ru nning the samp le.

Using the API

For learning how to use th is API, please refer to:

Javadocs from the following directory

TRA_HOME/doc/auth/javadoc

SampleAuthAPIUsage.java from a subd irectory within the following

samp les source d irectory:

TRA_HOME/sample/auth/src



18/21



Common Aspects of the API

For more d etails on the objects and classes referenced in th e section ah ead, refer tothe Javadocs as d escribed in the section API Overview on p age 3.

Objects and Factory

Two main objects are User an d Role. The factory classes UserFactory and

RoleFactory provide methods to retrieve the User and Role objects respectively.

AuthenticationSubject

An object of the Au thenticationSubject class represents an auth enticated u ser, and

contains such information as th e user nam e, password, and wh ether or not the

user is authenticated.

This is notused for validating the au thentication for the u sername and password

specified here. This is only used for such p urp oses as iden tifying the u ser orchecking role mem berships for a u ser. For information on checking auth orization,

refer to AuthUtils on page 6.

RoleMembershipConfig and RoleMembership

There are two major portions of the API: mod el and ru ntime. The mod el portion

of the API deals with m anaging the configuration of the Object. The run time

portion of the API contains ut ilities you can use to compu te something or take

some action.

RoleMembershipCon fig is the model comp onent th at prov ides details necessary

for comp uting th e membership of the role. RoleMembership is the runtime

compon ent that p rovides logic for compu ting the m embership of a Role. The

run time p ortion of the API is generally useful only in the context of custom Role

Membersh ip Plug ins. You w ill not have the necessary context to run this run time

API in a comman d-line context.

AuthUtils

The mod el objects such as User an d Role are pu rely data objects with n o behavior

exposed . This ut ility class exposes the beh avior for these objects. For examp le, it

provides role membersh ip, taking into account the m embership inh erited from

child roles.The single instance of this u tility class is obtained by calling instance() .

Best Practices |7


19/21


|

Best Practices

General Tips

The following sections provide som e general tips for d evelopers.

Log Files

When a p rogram w ritten using these API does not behave as expected, make sure

you check the

TIBCO_DOMAIN_HOME\TIBCO_DOMAIN_NAME\logs\Administrator.log

file. It may ind icate w hat exceptions or errors have been encountered.



20/21


|

| 9


21/21


|

Index

A

API Overview 3

C

Compiling Programs 4

customer support xi

EENV_NAME viii

G

Getting Started with the API 4

R

Running Programs 4

Running th e Samp les 5

S

support, contacting xi

T

technical support xi

TIBCO_HOME viii

TRA_HOME viii

U

Using the API 5

Date post:	05-Apr-2018
Category:	Documents
Upload:	burnssimon
View:	215 times
Download:	0 times

tib_tra_addon_auth_user

Documents