ProtectionEntry (Perforce Java API 2015.1.1210280 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.impl.generic.admin
Class ProtectionEntry

java.lang.Object
  com.perforce.p4java.impl.generic.core.MapEntry
      com.perforce.p4java.impl.generic.admin.ProtectionEntry

All Implemented Interfaces:: IProtectionEntry, IMapEntry

public class ProtectionEntry
extends MapEntry
implements IProtectionEntry
extends MapEntry
implements IProtectionEntry

Default IProtectionEntry implementation class.

Note that the order of this protection entry in the protections table is part of the protection entry key when pass to the server for updating the protections table.

When exclusionary mappings are used, order is relevant: the exclusionary mapping overrides any matching protections listed above it in the table. No matter what access level is being denied in the exclusionary protection, all the access levels for the matching users, files, and IP addresses are denied.

 Protections0: super user p4java * //depot/...
 Protections1: write group p4users * //depot/project1/...
 Protections2: write group p4users * -//depot/project1/build/...
 Protections3: read user p4jtestuser * //depot/...
 Protections4: read user p4jtestuser * -//depot/topsecret/...

Nested Class Summary

Nested classes/interfaces inherited from interface com.perforce.p4java.core.IMapEntry
`IMapEntry.EntryType`

Field Summary

Fields inherited from class com.perforce.p4java.impl.generic.core.MapEntry
`elementPattern, elementPatternStr, left, order, right, type`

Fields inherited from interface com.perforce.p4java.core.IMapEntry
`EXCLUDE_PREFIX, ORDER_UNKNOWN, OVERLAY_PREFIX`

Constructor Summary
`ProtectionEntry()` Default constructor -- sets all fields to null, zero, or false.
`ProtectionEntry(int order, String mode, boolean group, String host, String name, String path, boolean pathExcluded)` Explicit-value constructor.
`ProtectionEntry(Map<String,Object> map, int order)` Constructs a ProtectionEntry from the passed-in map; this map must have come from a Perforce IServer method call or it may fail.

Method Summary
`String`	`getHost()` Gets the client host.
`String`	`getMode()` Gets the protection mode for this entry.
`String`	`getName()` Gets the name of the grantee (user or group).
`String`	`getPath()` Gets the depot path.
`boolean`	`isGroup()` Checks if the grantee is a group.
`boolean`	`isPathExcluded()` Checks if the path is excluded.
`void`	`setGroup(boolean group)` Sets the group indicator (true/false).
`void`	`setHost(String host)` Sets the client host.
`void`	`setMode(String mode)` Sets the protection mode for this entry.
`void`	`setName(String name)` Sets the name of the grantee (user or group).
`void`	`setPath(String path)` Sets the depot path.
`void`	`setPathExcluded(boolean pathExcluded)` Sets the path excluded indicator (true/false).
`String`	`toString()` Returns string representation of the protection entry.

Methods inherited from class com.perforce.p4java.impl.generic.core.MapEntry
`getLeft, getLeft, getOrder, getRight, getRight, getType, parseViewMappingString, quoteWhitespaceString, setLeft, setOrder, setRight, setType, stripTypePrefix, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface com.perforce.p4java.core.IMapEntry
`getLeft, getLeft, getOrder, getRight, getRight, getType, setLeft, setOrder, setRight, setType, toString`

Constructor Detail

ProtectionEntry

public ProtectionEntry()

Default constructor -- sets all fields to null, zero, or false.

ProtectionEntry

public ProtectionEntry(int order,
                       String mode,
                       boolean group,
                       String host,
                       String name,
                       String path,
                       boolean pathExcluded)

Explicit-value constructor.

ProtectionEntry

public ProtectionEntry(Map<String,Object> map,
                       int order)

Constructs a ProtectionEntry from the passed-in map; this map must have come from a Perforce IServer method call or it may fail. If map is null, equivalent to calling the default constructor.

Method Detail