Software Requirement Specification Command Line Interface

Transcription

1 Software Requirement Specification Command Line Interface Federation Manager 7.5 Version 0.1 (Draft) Please send comments to: This document is subject to the following license: COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0

2

3 Contents 1 Introduction Document Status Revision History Summary Terminology Scope Context Glossary References Overview General Description Product Perspective User Characteristics Constraints Assumptions and Dependencies Future Requirements Specific Requirements Marketing Requirements Administration Requirements Performance Requirements Scalability Requirements Internationalization Requirements Help Requirements Security Requirements Open Issues Appendices...8 Copyright 2007 Sun Microsystems, Inc. All rights reserved. iii

4 Command Line Interface, Version 0.1 (Draft) iv Copyright 2007 Sun Microsystems, Inc. All rights reserved.

5 1 Introduction 1.1 Document Status Project Name Federation Manager 7.5 Document Title Command Line Interface Date of Issue 26 th February 2007 Current Version 0.1 (Draft) Author Dennis Seah Issuing Organization Sun Microsystems, Inc. Feedback 1.2 Revision History Date Version Author Comments 02/26/ Draft Dennis Seah First Draft 1.3 Summary This document describes the requirements for Command Line Interface (CLI) tool. The intended audience for this document includes product mangers, product marketing, developers and others who would like to understand the functionality of the product and would like to evaluate its features to suit their needs. 1.4 Terminology The words SHALL and MUST identify the mandatory (essential) requirements in this document. The words SHOULD and MAY identify optional (conditional) requirements. One is required for releasing the product - the other is desired, but not necessary. The words METHOD and MEANS identify some kind of technique by which the feature will be supported. They do not specifically imply either an API (programming language method or procedure) or a command. Copyright 2007 Sun Microsystems, Inc. All rights reserved. 1

6 Command Line Interface, Version 0.1 (Draft) Introduction 1.5 Scope This document describes the overall requirements for the CLI tool. It does not include the requirements for sub commands in the CLI. These sub commands shall be described in the individual feature SRSes. 1.6 Context Command Line Interface provides a mean to administer the product. For instance, CLI is used to create a policy; import and export IDFF meta data. It is designed to run on minimal system setup such as a text terminal and the availability of a Java (1.4 above) bytecode interpreter. The CLI is a good for performing a handful of tasks in batch. For instance, assign 100 subjects to a group and then add the group to a policy. 1.7 Glossary CLI IDFF JDK JSP PRD SRS Command Line Interface. A simple interface running on text terminal to administer the product. Identity Federation Framework. Java Development Toolkit Java Server Page TM Product Requirement Document Software Requirement Specification. 1.8 References [1] Software Requirement Specification Federation Manager 7.5 Version 0.2, Ping Luo, 01/19/2007. Section 3.2 Administration Requirements 2 Copyright 2007 Sun Microsystems, Inc. All rights reserved.

7 Overview Command Line Interface, Version 0.1 (Draft) 2 Overview CLI provides a mean to administer the product. It is usually used by administrator to perform a set of tasks in batch. It consumes very little resources than the Web Administration Console (in this document, it is referred as the Console). It is designed to run on a text terminal with Java (1.4 and above) bytecode interpreter. Due to its text based interface, it may not be more user friendly than the Console which is interactive. Although it is designed to operate in text terminal, it is also available on the web browser. This is to provide a convenience for administrator who deployed the product WAR and wants to have access to the CLI. Copyright 2007 Sun Microsystems, Inc. All rights reserved. 3

8

9 3 General Description 3.1 Product Perspective CLI provides a mean to administer/configure the product. CLI runs on text terminal and requires Java (1.4 and above) bytecode interpreter. CLI also runs in the product supported web browser. The JSP needs a web container with Java (1.4 and above) bytecode interpreter. The advantages of CLI is that it is lightweight and fast. It may be less user friendly than the Console 3.2 User Characteristics The typical user for CLI is realm and policy administrators who want to automate a set of tasks. These tasks can be execute in a sandbox and then execute in the real deployment environment. The simplicity of the tool makes it easily for administrator to do dry runs and then run on production setup with little chance for errors. User who does not have administrative rights does not use the CLI. 3.3 Constraints None 3.4 Assumptions and Dependencies The only dependency is Java (1.4 and above) bytecode interpreter. 3.5 Future Requirements CLI can be more user friendly if it is interactive. Copyright 2007 Sun Microsystems, Inc. All rights reserved. 5

10 Command Line Interface, Version 0.1 (Draft) Specific Requirements 4 Specific Requirements 4.1 Marketing Requirements 1. CLI shall be CLIP 1 compliant. 2. Short name shall be consistent e.g. -t for --type shall be for all sub commands. 3. Sub command name shall be easily to remember. 4. CLI shall support verbose and non verbose modes. 5. CLI shall support debug and non debug modes. 6. CLI shall be executable from text terminal. 7. CLI shall be executable for a web browser. 8. CLI shall provide usage (--help) for all sub commands. 9. We shall provide a document which contains samples for all sub commands. 10. CLI shall provide an option to accept administrator password from a file so that password will not be expose on the text terminal. 11. CLI shall block non privilege users in the web based interface. For sub commands requirement. please refer to individual feature SRSes. 4.2 Administration Requirements Deploy the product WAR, configure it and the web based CLI shall be available via a JSP. Unzip amadmintools.zip, make AMConfig.properties in the classpath, text based CLI shall be available via a Unix shell script or Windows bat file. 4.3 Performance Requirements None 4.4 Scalability Requirements None 1 CLIP is the CLI guidelines published by Sun Microsystems CTO office. 6 Copyright 2007 Sun Microsystems, Inc. All rights reserved.

11 Specific Requirements Command Line Interface, Version 0.1 (Draft) 4.5 Internationalization Requirements All messages shall be internationalization-ized. 4.6 Help Requirements Usage shall be provided on Standard IO when sub command name is entered. 4.7 Security Requirements All CLI operations shall be logged so that audit trails can be created. No sensitive information such as password is transmitted across the wire. Copyright 2007 Sun Microsystems, Inc. All rights reserved. 7

12 Command Line Interface, Version 0.1 (Draft) Open Issues 5 Open Issues None 8 Copyright 2007 Sun Microsystems, Inc. All rights reserved.

13 Appendices Command Line Interface, Version 0.1 (Draft) 6 Appendices None Copyright 2007 Sun Microsystems, Inc. All rights reserved. 9