What Is an Access Label?
An access label is a bitmask composed of combinations of ones and zeroes. Examples of access label bitmasks are shown in the following table:
Bitmask | Description |
110001 | 6-bit access label |
100100 | 6-bit access label |
110010010011 | 12-bit access label |
100010001000 | 12-bit access label |
110011001100110011001100 | 24-bit access label |
100000000000100000000000 | 24-bit access label |
You define access labels using a sequence of unsigned short values. Each value in the sequence represents a position in the bitmask. For the example bitmasks shown above, the corresponding access label definitions are shown in the following table:
Bitmask | Access Label Definition |
110001 | label[0]=5
label[1]=4
label[2]=0 |
100100 | label[0]=5
label[1]=2 |
110010010011 | label[0]=11
label[1]=10
label[2]=7
label[3]=4
label[4]=1
label[5]=0 |
100010001000 | label[0]=11
label[1]=7
label[2]=3 |
110011001100110011001100 | label[0]=23
label[1]=22
label[2]=19
label[3]=18
label[4]=15
label[5]=14
label[6]=11
label[7]=10
label[8]=7
label[9]=6
label[10]=3
label[11]=2 |
100000000000100000000000 | label[0]=23
label[1]=11 |
When defining access labels for the clients, duplicate values in the label are ignored. For example, the following labels:
label[0]=5
label[1]=4
label[2]=0
label[3]=5
label[4]=4
label[5]=0
are the same as:
label[0]=5
label[1]=4
label[2]=0
and both yield the following bitmask:
110001
However, duplicate values are not allowed when specifying an access label for a document during a publish operation.
The order in which you define the sequence of access labels is unimportant. For example, the following two groups of labels yield the same bitmask:
label[0]=5
label[1]=4
label[2]=0
and
label[0]=4
label[1]=0
label[2]=5
Note:
Negative values are invalid and will generate errors.