01: /**
02: * $Id: AttrOptionConstants.java,v 1.4 2005/05/16 03:36:15 pd109850 Exp $
03: * Copyright 2004 Sun Microsystems, Inc. All
04: * rights reserved. Use of this product is subject
05: * to license terms. Federal Acquisitions:
06: * Commercial Software -- Government Users
07: * Subject to Standard License Terms and
08: * Conditions.
09: *
10: * Sun, Sun Microsystems, the Sun logo, and Sun ONE
11: * are trademarks or registered trademarks of Sun Microsystems,
12: * Inc. in the United States and other countries.
13: */package com.sun.portal.admin.common;
14:
15: /**
16: * The constants defined here are used by both, the client as well as the
17: * server. As an example, the cli needs to know some of the options
18: * to perform validation and massage the data to be presented to mbean.
19: * The mbean needs to know some options like component name so that it
20: * can invoke the appropriate component handler. Then the component handler
21: * needs to know the options like attribute-name etc.
22: */
23: public interface AttrOptionConstants {
24: /**
25: * Key to String service name
26: * Clients set this as a friendly name into the map
27: * Handler use this to convert the friendly name to real name
28: */
29: String OPT_COMPONENT = "component";
30:
31: /**
32: * Key to String attr name
33: * Used by singular get/set methods to pass in the attr name
34: * Clients set this as a friendly name into the map
35: * Handler use this to convert the friendly name to real name
36: */
37: String OPT_ATTR_NAME = "attribute-name";
38:
39: /**
40: * Key to name Set
41: * Used by plural getAttributes methods to pass in a Set of
42: * attr names. This is a set of friendly names
43: */
44: String OPT_ATTR_NAMES = "attribute-names";
45:
46: /**
47: * Key to the dn string
48: * DN of the node, if any. Should be null for global type of attr
49: * and for setting the default values of org/dyn type attrs.
50: * Must be user's dn for user type of attrs.
51: */
52: String OPT_DN = "dn";
53:
54: /**
55: * Boolean flag to indicate global attr type
56: * Not supposed to be available from the cli
57: * as the user is not expected to know the type.
58: * The handler should set the appropriate value before calling super
59: * methods. For example, getAttribute method of component handler
60: * can set this in the options map before calling super.getAttribute
61: */
62: String OPT_GLOBAL = "global";
63:
64: /**
65: * Boolean flag to indicate org type of attr
66: * Not supposed to be available from the cli
67: * as the user is not expected to know the type.
68: * The handler should set the appropriate value before calling super
69: * methods. For example, getAttribute method of component handler
70: * can set this in the options map before calling super.getAttribute
71: */
72: String OPT_ORG = "org";
73:
74: /**
75: * Flag to indicate that the value is not provided for set operation
76: * and it should be used from the parent
77: * Used only for user attrs.
78: */
79: String OPT_INHERIT = "inherit";
80:
81: /**
82: * Key to a List of values to be added to a list type of an attr
83: */
84: String OPT_ADD = "add";
85:
86: /**
87: * Key to a List of values to be removed from a list type of an attr
88: */
89: String OPT_REMOVE = "remove";
90: }
|