public interface AdminMetadataManagerMBean
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
OBJECT_NAME
A String representing the
ObjectName that this MBean maps to. |
Modifier and Type | Method and Description |
---|---|
void |
addAdminMetadata(java.lang.String resourceType,
java.lang.String identity,
java.util.Map metadata)
Create administrative metadata for the given resource type, identity and metadata map.
|
void |
addAdminTag(java.lang.String resourceType,
java.lang.String identity,
java.lang.String tag)
Create a tag for the given resource type and identity.
|
void |
addAdminTags(java.lang.String resourceType,
java.lang.String identity,
java.lang.String[] tags)
Create tags for the given resource type and identity.
|
void |
deployAdminMetadata(java.lang.String resourceType,
java.lang.String identity,
java.util.Map metadata)
Deploy administrative metadata for the given resource type, identity and metadata map.
|
java.util.Map<java.lang.String,java.lang.Object> |
getAdminMetadata(java.lang.String resourceType,
java.lang.String identity)
Retrieve all administrative metadata for the given resource type and identity.
|
java.util.Map<java.lang.String,java.lang.Object> |
getAdminMetadata(java.lang.String resourceType,
java.lang.String identity,
java.lang.String[] mapKeys)
Retrieve requested keys of administrative metadata for the given resource type and identity.
|
java.lang.String[] |
getAdminTags(java.lang.String resourceType,
java.lang.String identity)
Retrieve all admin and deploy tags for the given resourceType and identity.
|
java.lang.String[] |
getResourceIdentities(java.lang.String resourceType)
Get the identities for a resource type.
|
java.lang.String[] |
getTags()
Retrieve all unique tags across all resource types.
|
void |
removeAdminMetadata(java.lang.String resourceType,
java.lang.String identity,
java.util.Map metadata)
Remove administrative metadata from the given resource type and identity, that matches the metadata map.
|
void |
removeAdminTag(java.lang.String resourceType,
java.lang.String identity,
java.lang.String tag)
Remove a specific tag for the given resource type and identity.
|
void |
removeAdminTags(java.lang.String resourceType,
java.lang.String identity)
Remove all tags for a given resource type and identity.
|
void |
removeAllAdminMetadata(java.lang.String resourceType,
java.lang.String identity)
Remove all administrative metadata from the given resource type and identity.
|
void |
removeAllMetadata(java.lang.String identity)
Remove the administrative metadata for all resource types for the given identity.
|
java.util.Map<java.lang.String,java.lang.String[]> |
searchResources(java.util.Map<java.lang.String,java.lang.Object> metadata)
Return all the identities that match any of the data in the supplied metadata map.
|
java.lang.String[] |
searchResources(java.lang.String resourceType,
java.util.Map<java.lang.String,java.lang.Object> metadata)
For a specified resource type, return all the identities that match any of the data in the supplied metadata map.
|
void |
setAdminMetadata(java.lang.String resourceType,
java.lang.String identity,
java.util.Map<java.lang.String,java.lang.Object> metadata)
Set (replace) all administrative metadata for the given resource type and identity with the supplied metadata map.
|
void |
setAdminTags(java.lang.String resourceType,
java.lang.String identity,
java.lang.String[] tags)
Set (replace) all tags for the given resource type and identity.
|
static final java.lang.String OBJECT_NAME
ObjectName
that this MBean maps to.void addAdminMetadata(java.lang.String resourceType, java.lang.String identity, java.util.Map metadata) throws java.io.IOException
Any metadata that is not identified with an expected map key as defined below, is ignored with no exception.
A map entry that has an expected key, but the data for that key is not as expected will result in an IllegalArgumentException, but only after all other properly formed keys and their data have been processed. In the case that there are multiple instances of expected keys with improper data, only the first such occurrence is thrown in the IllegalArgumentException.
resourceType
- resource type includes server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
metadata
- a map of admin metadata. This is a map with the possible keys: tags, owner, contacts and note. The value for each key
is as follows:
java.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
void deployAdminMetadata(java.lang.String resourceType, java.lang.String identity, java.util.Map metadata) throws java.lang.IllegalArgumentException, java.io.IOException
Any metadata that is not identified with an expected map key as defined below, is ignored with no exception.
A map entry that has an expected key, but the data for that key is not as expected will result in an IllegalArgumentException, but only after all other properly formed keys and their data have been processed. In the case that there are multiple instances of expected keys with improper data, only the first such occurrence is thrown in the IllegalArgumentException.
resourceType
- resource type includes server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
metadata
- a map of admin metadata. This is a map with the possible keys: tags, owner, contacts and note. The value for each key
is as follows:
java.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
java.util.Map<java.lang.String,java.lang.Object> getAdminMetadata(java.lang.String resourceType, java.lang.String identity) throws java.lang.IllegalArgumentException, java.io.IOException
resourceType
- resource type includes server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
java.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
java.util.Map<java.lang.String,java.lang.Object> getAdminMetadata(java.lang.String resourceType, java.lang.String identity, java.lang.String[] mapKeys) throws java.lang.IllegalArgumentException, java.io.IOException
resourceType
- resource type includes server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
mapKeys
- the map keys to be returned for this request. The possible map keys includes tags, owner, contacts and notejava.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
void setAdminMetadata(java.lang.String resourceType, java.lang.String identity, java.util.Map<java.lang.String,java.lang.Object> metadata) throws java.lang.IllegalArgumentException, java.io.IOException
resourceType
- resource type includes server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
metadata
- a map of admin metadata. This is a map with the possible keys: tags, owner, contacts and note. The value for each key
is as follows:
java.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
void removeAdminMetadata(java.lang.String resourceType, java.lang.String identity, java.util.Map metadata) throws java.io.IOException
resourceType
- resource type includes server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
metadata
- a map of admin metadata. This is a map with the possible keys: tags, owner, contacts and note. This map should include the
specific values to delete for the desired keys. The value for each key is as follows:
java.io.IOException
- If there was a problem accessing the repository for the requestvoid removeAllAdminMetadata(java.lang.String resourceType, java.lang.String identity) throws java.lang.IllegalArgumentException, java.io.IOException
resourceType
- resource type including server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
java.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
void removeAllMetadata(java.lang.String identity) throws java.io.IOException
identity
- specifies the unique resource for this action. This might be:
java.io.IOException
- If there was a problem accessing the repository for the requestvoid addAdminTag(java.lang.String resourceType, java.lang.String identity, java.lang.String tag) throws java.lang.IllegalArgumentException, java.io.IOException
resourceType
- resource type including server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
tag
- to be addedjava.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
void addAdminTags(java.lang.String resourceType, java.lang.String identity, java.lang.String[] tags) throws java.lang.IllegalArgumentException, java.io.IOException
resourceType
- resource types including server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
tags
- array of tags to be added to the identityjava.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
java.lang.String[] getAdminTags(java.lang.String resourceType, java.lang.String identity) throws java.lang.IllegalArgumentException, java.io.IOException
resourceType
- resource types including server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
java.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
java.lang.String[] getTags() throws java.lang.IllegalArgumentException, java.io.IOException
java.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
java.lang.String[] getResourceIdentities(java.lang.String resourceType) throws java.lang.IllegalArgumentException, java.io.IOException
resourceType
- resource types including server, application, cluster, host and runtime.java.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
void setAdminTags(java.lang.String resourceType, java.lang.String identity, java.lang.String[] tags) throws java.lang.IllegalArgumentException, java.io.IOException
resourceType
- resource types including server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
tags
- array of tagsjava.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
void removeAdminTag(java.lang.String resourceType, java.lang.String identity, java.lang.String tag) throws java.lang.IllegalArgumentException, java.io.IOException
resourceType
- resource types including server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
tag
- to be removedjava.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
void removeAdminTags(java.lang.String resourceType, java.lang.String identity) throws java.lang.IllegalArgumentException, java.io.IOException
resourceType
- resource types including server, application, cluster, host and runtime.identity
- specifies the unique resource for this action. This might be:
java.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
java.lang.String[] searchResources(java.lang.String resourceType, java.util.Map<java.lang.String,java.lang.Object> metadata) throws java.lang.IllegalArgumentException, java.io.IOException
resourceType
- resource types including server, application, cluster, host and runtime.metadata
- a map of admin metadata. This is a map with the possible keys: tags, owner, contacts and note. If a key has a value of null, this
means return any identity that has that type of metadata (for example, an owner), no matter the value. The value for each key
is as follows:
java.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException
java.util.Map<java.lang.String,java.lang.String[]> searchResources(java.util.Map<java.lang.String,java.lang.Object> metadata) throws java.lang.IllegalArgumentException, java.io.IOException
metadata
- a map of admin metadata. This is a map with the possible keys: tags, owner, contacts and note. If a key has a value of null, this
means return any identity that has that type of metadata (for example, an owner), no matter the value. The value for each key
is as follows:
Each key will have a value that is an array of identities (String[]). An identity specifies a unique resource and can be in the following forms:
java.io.IOException
- If there was a problem accessing the repository for the requestjava.lang.IllegalArgumentException