Package org.glassfish.admin.amx.base

Interface Realms

All Superinterfaces:

AMX_SPI, AMXProxy, Singleton, Utility

@Taxonomy(stability=UNCOMMITTED)
@AMXMBeanMetadata(singleton=true,
                  globalSingleton=true,
                  leaf=true)
public interface Realms
extends AMXProxy, Utility, Singleton

Since:

GlassFish V3

Method Summary

Modifier and Type	Method	Description
void	addUser(String realm, String user, String password, String[] groupList)
String	getAnonymousUser()
String	getDefaultRealmName()
String[]	getGroupNames(String realm)
String[]	getGroupNames(String realm, String user)
String[]	getPredefinedAuthRealmClassNames()
String[]	getRealmNames()	get the names of all realms
Map<String,Object>	getUserAttributes(String realm, String user)
String[]	getUserNames(String realm)
void	removeUser(String realm, String user)
void	setDefaultRealmName(String realmName)
boolean	supportsUserManagement(String realmName)
void	updateUser(String realm, String user, String newUser, String password, String[] groupList)

Methods inherited from interface org.glassfish.admin.amx.core.AMX_SPI

getChildren, getName, getParent

Methods inherited from interface org.glassfish.admin.amx.core.AMXProxy

as, attributeNames, attributesMap, attributesMap, child, child, childrenMap, childrenMap, childrenMaps, childrenSet, extra, invokeOp, invokeOp, java, nameProp, objectName, parent, parentPath, path, type, valid

Method Detail

getRealmNames

@ManagedAttribute
String[] getRealmNames()

get the names of all realms

getPredefinedAuthRealmClassNames

@ManagedAttribute
String[] getPredefinedAuthRealmClassNames()

getDefaultRealmName

@ManagedAttribute
String getDefaultRealmName()

setDefaultRealmName

@ManagedAttribute
void setDefaultRealmName(String realmName)

addUser

@ManagedOperation(impact=1)
void addUser(String realm,
             String user,
             String password,
             String[] groupList)

updateUser

@ManagedOperation(impact=1)
void updateUser(String realm,
                String user,
                String newUser,
                String password,
                String[] groupList)

removeUser

@ManagedOperation(impact=1)
void removeUser(String realm,
                String user)

getUserNames

@ManagedOperation(impact=0)
String[] getUserNames(String realm)

getGroupNames

@ManagedOperation(impact=0)
String[] getGroupNames(String realm)

getUserAttributes

@ManagedOperation(impact=0)
Map<String,Object> getUserAttributes(String realm,
                                           String user)

getGroupNames

@ManagedOperation(impact=0)
String[] getGroupNames(String realm,
                       String user)

supportsUserManagement

@ManagedOperation(impact=0)
boolean supportsUserManagement(String realmName)

Returns:

true if the realm implementation support User Management (add,remove,update user)

getAnonymousUser

@ManagedAttribute
String getAnonymousUser()

Returns:

the username of any user that uses an empty password