|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.tivoli.pd.jadmin.PDProtObject
Access Manager Protected Object class.
Protected objects are objects in the protected namespace that have an ACL attached to them. Each is uniquely identified by its namespace ID.
Unlike the Admin C API, there is no type associated with a protected object. Extended attributes need to be used instead.
Constructor Summary | |
PDProtObject(PDContext context,
java.lang.String id,
PDAttrs inData,
PDAttrs outData,
PDMessages messages)
Constructs a local object of a protected object that already exists in the policy server. |
Method Summary | |
void |
attachAcl(PDContext context,
java.lang.String aclId,
PDMessages messages)
Attaches an ACL to a protected object in the policy server, and in this object. |
static void |
attachAcl(PDContext context,
java.lang.String id,
java.lang.String aclId,
PDMessages messages)
Attaches an ACL to a protected object in the policy server. |
void |
attachPop(PDContext context,
java.lang.String popId,
PDMessages messages)
Attaches a Pop to a protected object in the policy server, and in this object. |
static void |
attachPop(PDContext context,
java.lang.String id,
java.lang.String popId,
PDMessages messages)
Attaches a Pop to a protected object in the policy server. |
java.lang.Object |
clone()
Returns a copy of this object. |
static void |
createProtObject(PDContext context,
java.lang.String id,
java.lang.String description,
boolean isPolicyAttachable,
java.lang.String aclId,
PDAttrs attributes,
PDMessages messages)
Creates a protected object in the policy server. |
void |
deleteAttribute(PDContext context,
java.lang.String attributeName,
PDMessages messages)
Deletes the extended attribute for this protected object in the policy server and also in this object. |
static void |
deleteAttribute(PDContext context,
java.lang.String id,
java.lang.String attributeName,
PDMessages messages)
Deletes the extended attribute for a protected object in the policy server. |
void |
deleteAttributeValue(PDContext context,
java.lang.String attributeName,
java.lang.String attributeValue,
PDMessages messages)
Deletes a value for an extended attribute for this protected object in the policy server and also in this object. |
static void |
deleteAttributeValue(PDContext context,
java.lang.String id,
java.lang.String attributeName,
java.lang.String attributeValue,
PDMessages messages)
Deletes a value for an extended attribute for a protected object in the policy server. |
static void |
deleteProtObject(PDContext context,
java.lang.String id,
PDMessages messages)
Deletes a protected object in the policy server. |
void |
detachAcl(PDContext context,
PDMessages messages)
Detaches an ACL from a protected object in the policy server, and in this object. |
static void |
detachAcl(PDContext context,
java.lang.String id,
PDMessages messages)
Detaches an ACL from a protected object in the policy server. |
void |
detachPop(PDContext context,
PDMessages messages)
Detaches a Pop from a protected object in the policy server, and in this object. |
static void |
detachPop(PDContext context,
java.lang.String id,
PDMessages messages)
Detaches a Pop from a protected object in the policy server. |
boolean |
equals(java.lang.Object obj)
Determines whether this PDProtObject is equivalent to the input object. |
PDAcl |
getAcl()
Gets the ACL of this protected object. |
java.util.ArrayList |
getAttributeNames()
Gets the names of the extended attributes for this protected object. |
java.util.ArrayList |
getAttributeValues(java.lang.String attributeName)
Gets the value(s) of an extended attribute for this protected object. |
java.lang.String |
getDescription()
Gets the description of this protected object. |
java.lang.String |
getId()
Gets the name of this protected object. |
PDPop |
getPop()
Gets the Pop attached to this protected object. |
boolean |
isPolicyAttachable()
Gets the isPolicyAttachable flag of this protected object. |
static java.util.ArrayList |
listProtObjects(PDContext context,
java.lang.String id,
PDAttrs inData,
PDAttrs outData,
PDMessages messages)
Returns a list of protected objects under the specified directory in the policy server. |
static java.util.ArrayList |
listProtObjectsByAcl(PDContext context,
java.lang.String aclId,
PDMessages messages)
Returns a list of protected objects that exist in the policy server and have the specified ACL attached. |
static java.util.ArrayList |
listProtObjectsByPop(PDContext context,
java.lang.String popId,
PDMessages messages)
Returns a list of protected objects that exist in the policy server and have the specified Pop attached. |
void |
setAttributeValue(PDContext context,
java.lang.String attributeName,
java.lang.String attributeValue,
PDMessages messages)
Sets the value of an extended attribute for this protected object in the policy server and also in this object. |
static void |
setAttributeValue(PDContext context,
java.lang.String id,
java.lang.String attributeName,
java.lang.String attributeValue,
PDMessages messages)
Sets the value of an extended attribute for a protected object in the policy server. |
void |
setDescription(PDContext context,
java.lang.String newDescription,
PDMessages messages)
Sets the descriptive string for a protected object in the policy server, and in this object. |
static void |
setDescription(PDContext context,
java.lang.String id,
java.lang.String newDescription,
PDMessages messages)
Sets the descriptive string for a protected object in the policy server. |
void |
setPolicyAttachable(PDContext context,
boolean isPolicyAttachable,
PDMessages messages)
Sets whether policy can be attached to a protected object in the policy server, and in this object. |
static void |
setPolicyAttachable(PDContext context,
java.lang.String id,
boolean isPolicyAttachable,
PDMessages messages)
Sets whether policy can be attached to a protected object in the policy server. |
java.lang.String |
toString()
Returns a String representation of this object. |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public PDProtObject(PDContext context, java.lang.String id, PDAttrs inData, PDAttrs outData, PDMessages messages) throws PDException
This constructor is equivalent to the ivadmin_protobj_get2() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- name of the protected object to be constructed.
Cannot be null.inData
- Specifies a PDAttrs
object containing pass-thru data with additional
information to be communicated to the server.
Can be null if no pass-thru data is needed.outData
- in/out parameter;
empty PDAttrs
on input;
may contain passthru data (if an AM application
server manages this protected object)
on output.
Can be null if no pass-thru data is expected.
However, if null, then any pass-thru data
returned by the server will not be returned.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.Method Detail |
public void setDescription(PDContext context, java.lang.String newDescription, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_protobj_setdesc() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.newDescription
- descriptive string for the protected object.
If null, an empty string is assumed.
The input parameter is not changed.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational
or warning messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public void setPolicyAttachable(PDContext context, boolean isPolicyAttachable, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_protobj_setpolicyattachable() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.isPolicyAttachable
- True if a policy can be attached to the
protected object, False otherwise. Protected
Object Policies (POPs) will be supported in
the future (equivalent to the ivadmin_pop_*
C APIs).messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational
or warning messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public void attachAcl(PDContext context, java.lang.String aclId, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_protobj_attachacl() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.aclId
- name of the ACL to attach.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational
or warning messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public void detachAcl(PDContext context, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_protobj_detachacl() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational
or warning messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public void attachPop(PDContext context, java.lang.String popId, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_pop_attach() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.popId
- name of the Pop to attach.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational
or warning messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public void detachPop(PDContext context, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_pop_detach() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational
or warning messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public void setAttributeValue(PDContext context, java.lang.String attributeName, java.lang.String attributeValue, PDMessages messages) throws PDException
Creates the attribute if it does not exist, and sets the specified value. If the attribute already exists, adds the specified value as an additional value for this attribute.
This method implements the function provided by the ivadmin_protobj_attrput() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.attributeName
- name of the extended attribute. Cannot be null.attributeValue
- string value of the attribute. Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public void deleteAttribute(PDContext context, java.lang.String attributeName, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_protobj_attrdelkey() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.attributeName
- name of the extended attribute.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public void deleteAttributeValue(PDContext context, java.lang.String attributeName, java.lang.String attributeValue, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_protobj_attrdelval() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.attributeName
- name of the extended attribute. Cannot be null.attributeValue
- string value of the extended attribute.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public java.lang.String getId() throws PDException
This method implements the function provided by the ivadmin_protobj_getid() C API.
PDException
- if an error occurs.public java.lang.String getDescription() throws PDException
This method implements the function provided by the ivadmin_protobj_getdescription() C API.
PDException
- if an error occurs.public boolean isPolicyAttachable() throws PDException
This method implements the function provided by the ivadmin_protobj_getpolicyattachable() C API.
PDException
- if an error occurs.public PDAcl getAcl() throws PDException
This method implements the function provided by the ivadmin_protobj_getacl() C API.
PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public PDPop getPop() throws PDException
This method implements the function provided by the ivadmin_protobj_getpop() C API.
PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public java.util.ArrayList getAttributeNames() throws PDException
This method implements the function provided by the ivadmin_protobj_attrlist() C API.
PDException
- if an error occurs.public java.util.ArrayList getAttributeValues(java.lang.String attributeName) throws PDException
This method implements the function provided by the ivadmin_protobj_attrget() C API.
attributeName
- name of the extended attributePDException
- if an error occurs.public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.Object clone()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public static void createProtObject(PDContext context, java.lang.String id, java.lang.String description, boolean isPolicyAttachable, java.lang.String aclId, PDAttrs attributes, PDMessages messages) throws PDException
This method is equivalent to the ivadmin_protobj_create() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- name of the protected object.
A valid name needs to start with the name of
an existing PDProtObjectSpace followed by a
forward slash and one or more characters.
Cannot be null.description
- description of the protected object.
If null, an empty string is assumed.
The input parameter is not changed.isPolicyAttachable
- can policy be attached to this protected object?aclId
- name of the ACL to be attached.
Will be supported in the future. For now, pass
a null value for this parameter.
Use the attachAcl() method to set the ACL for
the protected object.attributes
- extended attributes for this protected object.
Will be supported in the future. For now, pass
a null value for this parameter. Use the
setAttributeValue() method to set the attributes
for the protected object.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static java.util.ArrayList listProtObjects(PDContext context, java.lang.String id, PDAttrs inData, PDAttrs outData, PDMessages messages) throws PDException
This method is equivalent to the ivadmin_protobj_list3() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- Parent directory within the protected objectspace.
Cannot be null.inData
- Specifies a PDAttrs
object containing pass-thru data with additional
information to be communicated to the server.outData
- in/out parameter;
empty PDAttrs
on input;
may contain passthru data (if an AM application
server manages this protected object directory)
on output.
Can be null if no pass-thru data is expected.
However, if null, then any pass-thru data
returned by the server will not be returned.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static java.util.ArrayList listProtObjectsByAcl(PDContext context, java.lang.String aclId, PDMessages messages) throws PDException
This method is equivalent to the ivadmin_protobj_listbyacl() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.aclId
- name of the ACL.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static java.util.ArrayList listProtObjectsByPop(PDContext context, java.lang.String popId, PDMessages messages) throws PDException
This method is equivalent to the ivadmin_pop_find() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.popId
- name of the Pop.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static void deleteProtObject(PDContext context, java.lang.String id, PDMessages messages) throws PDException
This method is equivalent to the ivadmin_protobj_delete() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- name of the protected object to be deleted. A valid
name is that of a protected object that already exists.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static void setDescription(PDContext context, java.lang.String id, java.lang.String newDescription, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_protobj_setdesc() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- name of the protected object.
Cannot be null.newDescription
- Descriptive string for the protected object.
If null, an empty string is assumed.
The input parameter is not changed.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational
or warning messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static void setPolicyAttachable(PDContext context, java.lang.String id, boolean isPolicyAttachable, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_protobj_setpolicyattachable() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- name of the protected object.
Cannot be null.isPolicyAttachable
- True if a policy can be attached to the
protected object, False otherwise. Protected
Object Policies (POPs) will be supported in
the future (equivalent to the ivadmin_pop_*
C APIs).messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational
or warning messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static void attachAcl(PDContext context, java.lang.String id, java.lang.String aclId, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_protobj_attachacl() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- name of the protected object.
Cannot be null.aclId
- name of the ACL to attach.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational
or warning messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static void detachAcl(PDContext context, java.lang.String id, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_protobj_detachacl() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- name of the protected object.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational
or warning messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static void attachPop(PDContext context, java.lang.String id, java.lang.String popId, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_pop_attach() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- name of the protected object.
Cannot be null.popId
- name of the Pop to attach.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational
or warning messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static void detachPop(PDContext context, java.lang.String id, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_pop_detach() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- name of the protected object.
Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational
or warning messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static void setAttributeValue(PDContext context, java.lang.String id, java.lang.String attributeName, java.lang.String attributeValue, PDMessages messages) throws PDException
Creates the attribute if it does not exist, and sets the specified value. If the attribute already exists, adds the specified value as an additional value for this attribute.
This method implements the function provided by the ivadmin_protobj_attrput() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- name of the protected object.
Cannot be null.attributeName
- name of the extended attribute. Cannot be null.attributeValue
- string value of the attribute. Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static void deleteAttribute(PDContext context, java.lang.String id, java.lang.String attributeName, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_protobj_attrdelkey() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- name of the protected object. Cannot be null.attributeName
- name of the extended attribute. Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.public static void deleteAttributeValue(PDContext context, java.lang.String id, java.lang.String attributeName, java.lang.String attributeValue, PDMessages messages) throws PDException
This method implements the function provided by the ivadmin_protobj_attrdelval() C API.
context
- PDContext to be used to communicate with the
policy server.
Cannot be null.id
- name of the protected object. Cannot be null.attributeName
- name of the extended attribute. Cannot be null.attributeValue
- value of the extended attribute. Cannot be null.messages
- in/out parameter;
empty PDMessages on input;
might contain zero or more informational or warning
messages on output.
Cannot be null.PDException
- if an error occurs.
This exception might contain error and message codes defined in the
product Error Message Reference document.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |