aboutsummaryrefslogtreecommitdiffstats
path: root/core/src/main/java/org/onap/policy/apex/core/infrastructure/threading/ApplicationThreadFactory.java
blob: 9345abaaaa5258f283d698b16f6580ee53f44c45 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
 *  Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.core.infrastructure.threading;

import java.util.concurrent.ThreadFactory;
import java.util.concurrent.atomic.AtomicInteger;
import lombok.Getter;

/**
 * This class provides a thread factory for use by classes that require thread factories to handle concurrent operation.
 *
 * @author Sajeevan Achuthan (sajeevan.achuthan@ericsson.com)
 */
public class ApplicationThreadFactory implements ThreadFactory {
    private static final String HYPHEN = "-";
    private static final String APPLICATION_NAME = "Apex-";
    private static final AtomicInteger NEXT_POOL_NUMBER = new AtomicInteger();
    private final ThreadGroup group;
    private final AtomicInteger nextThreadNumber = new AtomicInteger();

    @Getter
    private final String name;
    @Getter
    private final long stackSize;
    @Getter
    private final int threadPriority;

    /**
     * Instantiates a new application thread factory with a default stack size and normal thread priority.
     *
     * @param nameLocal the name local
     */
    public ApplicationThreadFactory(final String nameLocal) {
        this(nameLocal, 0);
    }

    /**
     * Instantiates a new application thread factory with a default normal thread priority.
     *
     * @param nameLocal the name local
     * @param stackSize the stack size
     */
    public ApplicationThreadFactory(final String nameLocal, final long stackSize) {
        this(nameLocal, stackSize, Thread.NORM_PRIORITY);
    }

    /**
     * Instantiates a new application thread factory with a specified thread priority.
     *
     * @param nameLocal the name local
     * @param stackSize the stack size
     * @param threadPriority the thread priority
     */
    public ApplicationThreadFactory(final String nameLocal, final long stackSize, final int threadPriority) {
        final var s = System.getSecurityManager();
        group = (s != null) ? s.getThreadGroup() : Thread.currentThread().getThreadGroup();
        name = APPLICATION_NAME + nameLocal + HYPHEN + NEXT_POOL_NUMBER.getAndIncrement();
        this.stackSize = stackSize;
        this.threadPriority = threadPriority;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public Thread newThread(final Runnable runnable) {
        final Thread thisThread;
        if (stackSize > 0) {
            thisThread = new Thread(group, runnable, name + ':' + nextThreadNumber.getAndIncrement(), stackSize);
        } else {
            thisThread = new Thread(group, runnable, name + ':' + nextThreadNumber.getAndIncrement());
        }
        if (thisThread.isDaemon()) {
            thisThread.setDaemon(false);
        }
        thisThread.setPriority(threadPriority);

        return thisThread;
    }

    /**
     * Stop group threads.
     */
    public void stopGroupThreads() {
        group.interrupt();
        group.list();

    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public String toString() {
        return "ApplicationThreadFactory [nextPoolNumber=" + NEXT_POOL_NUMBER + ",nextThreadNumber=" + nextThreadNumber
                + ", name=" + name + ", stackSize=" + stackSize + ", threadPriority=" + threadPriority + "]";
    }
}