Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.mysql

Enum Permission

java.lang.Object

java.lang.Enum<Permission>

com.aoindustries.aoserv.client.mysql.Permission

All Implemented Interfaces:

Serializable, Comparable<Permission>

public enum Permission
extends Enum<Permission>

The platform-supported set of permissions for MySQL servers.

Author:

AO Industries, Inc.

See Also:

• Server.Version
• User
• DatabaseUser

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALTER
ALTER_ROUTINE
CREATE
CREATE_ROUTINE
CREATE_TMP_TABLE
CREATE_USER
CREATE_VIEW
DELETE
DROP
EVENT
EXECUTE
FILE
GRANT
INDEX
INSERT
LOCK_TABLES
PROCESS
REFERENCES
RELOAD
REPL_CLIENT
REPL_SLAVE
SELECT
SHOW_DB
SHOW_VIEW
SHUTDOWN
SUPER
TRIGGER
UPDATE

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Gets the display name of this permission.
String	getMysqlColumn()	The column name used in the MySQL grant tables.
String	getMysqlPrivilegeType()	The privilege type used in MySQL GRANT and REVOKE.
boolean	isDatabaseUserGranted(DatabaseUser databaseUser)	Is this permission granted to the given DatabaseUser?
boolean	isDatabaseUserPermission()	Does this permission have a representation in DatabaseUser?
boolean	isSupportedOn(Server.Version version)	Is this permission supported on the given MySQL version?
boolean	isUserGranted(User user)	Is this permission granted to the given User?
boolean	isUserPermission()	Does this permission have a representation in User?
String	toString()
static Permission	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Permission[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SELECT

public static final Permission SELECT

INSERT

public static final Permission INSERT

UPDATE

public static final Permission UPDATE

DELETE

public static final Permission DELETE

CREATE

public static final Permission CREATE

DROP

public static final Permission DROP

RELOAD

public static final Permission RELOAD

SHUTDOWN

public static final Permission SHUTDOWN

PROCESS

public static final Permission PROCESS

FILE

public static final Permission FILE

GRANT

public static final Permission GRANT

REFERENCES

public static final Permission REFERENCES

INDEX

public static final Permission INDEX

ALTER

public static final Permission ALTER

SHOW_DB

public static final Permission SHOW_DB

SUPER

public static final Permission SUPER

CREATE_TMP_TABLE

public static final Permission CREATE_TMP_TABLE

LOCK_TABLES

public static final Permission LOCK_TABLES

EXECUTE

public static final Permission EXECUTE

REPL_SLAVE

public static final Permission REPL_SLAVE

REPL_CLIENT

public static final Permission REPL_CLIENT

CREATE_VIEW

public static final Permission CREATE_VIEW

SHOW_VIEW

public static final Permission SHOW_VIEW

CREATE_ROUTINE

public static final Permission CREATE_ROUTINE

ALTER_ROUTINE

public static final Permission ALTER_ROUTINE

CREATE_USER

public static final Permission CREATE_USER

EVENT

public static final Permission EVENT

TRIGGER

public static final Permission TRIGGER

Method Details

values

public static Permission[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Permission valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<Permission>

See Also:

• getDisplayName()

getDisplayName

public String getDisplayName()

Gets the display name of this permission.

getMysqlColumn

public String getMysqlColumn()

The column name used in the MySQL grant tables.

getMysqlPrivilegeType

public String getMysqlPrivilegeType()

The privilege type used in MySQL GRANT and REVOKE.

isSupportedOn

public boolean isSupportedOn(Server.Version version)

Is this permission supported on the given MySQL version?

See Also:

• Server.Version.getDatabaseUserPermissions()
• Server.Version.getUserPermissions()

isUserPermission

public boolean isUserPermission()

Does this permission have a representation in User?

See Also:

• Server.Version.getUserPermissions()

isUserGranted

public boolean isUserGranted(User user)
                      throws IllegalStateException

Is this permission granted to the given User?

Throws:

IllegalStateException - when not isUserPermission().

See Also:

• Server.Version.getUserPermissions()

isDatabaseUserPermission

public boolean isDatabaseUserPermission()

Does this permission have a representation in DatabaseUser?

See Also:

• Server.Version.getDatabaseUserPermissions()

isDatabaseUserGranted

public boolean isDatabaseUserGranted(DatabaseUser databaseUser)
                              throws IllegalStateException

Is this permission granted to the given DatabaseUser?

Throws:

IllegalStateException - when not isDatabaseUserPermission().

See Also:

• Server.Version.getDatabaseUserPermissions()